This documentation is archived and is not being maintained.

FileWebRequest.BeginGetRequestStream Method

Begins an asynchronous request for a Stream object to use to write data.

Namespace:  System.Net
Assembly:  System (in System.dll)

'Declaration
<HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading := True)> _
Public Overrides Function BeginGetRequestStream ( _
	callback As AsyncCallback, _
	state As Object _
) As IAsyncResult
'Usage
Dim instance As FileWebRequest 
Dim callback As AsyncCallback 
Dim state As Object 
Dim returnValue As IAsyncResult 

returnValue = instance.BeginGetRequestStream(callback, _
	state)

Parameters

callback
Type: System.AsyncCallback

The AsyncCallback delegate.

state
Type: System.Object

An object that contains state information for this request.

Return Value

Type: System.IAsyncResult
An IAsyncResult that references the asynchronous request.

ExceptionCondition
ProtocolViolationException

The Method property is GET and the application writes to the stream.

InvalidOperationException

The stream is being used by a previous call to BeginGetRequestStream.

ApplicationException

No write stream is available.

NoteNote:

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: ExternalThreading. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

The BeginGetRequestStream method starts an asynchronous request for a stream used to send data to a file system resource. The callback method that implements the AsyncCallback delegate uses the EndGetRequestStream method to return the request stream.

The following code example uses BeginGetRequestStream to make an asynchronous request for a Stream object.

Public Class RequestDeclare
    Public myFileWebRequest As FileWebRequest
    Public userinput As [String]


    Public Sub New()
        myFileWebRequest = Nothing 
    End Sub ' New 
End Class ' RequestDeclare


Class FileWebRequest_reqbeginend
    Public Shared allDone As New ManualResetEvent(False)

    ' Entry point which delegates to C-style main Private Function. 
    Public Overloads Shared Sub Main()
        Main(System.Environment.GetCommandLineArgs())
    End Sub 


    Overloads Shared Sub Main(args() As String)
        If args.Length < 2 Then
            Console.WriteLine(ControlChars.Cr + "Please enter the file name as command line parameter:")
            Console.WriteLine("Usage:FileWebRequest_reqbeginend <systemname>/<sharedfoldername>/<filename>")
	    Console.WriteLine("Example: FileWebRequest_reqbeginend shafeeque/shaf/hello.txt")

        Else 
            Try 

                ' Place a webrequest. 
                Dim myWebRequest As WebRequest = WebRequest.Create(("file://" + args(1)))

                ' Create an instance of the 'RequestDeclare' and associate the 'myWebRequest' to it.		 
                Dim requestDeclare As New RequestDeclare()
                requestDeclare.myFileWebRequest = CType(myWebRequest, FileWebRequest)
                ' Set the 'Method' property of 'FileWebRequest' object to 'POST' method.
                requestDeclare.myFileWebRequest.Method = "POST"
                Console.WriteLine("Enter the string you want to write into the file:")
                requestDeclare.userinput = Console.ReadLine()

                ' Begin the Asynchronous request for getting file content using 'BeginGetRequestStream()' method . 
                Dim r As IAsyncResult = CType(requestDeclare.myFileWebRequest.BeginGetRequestStream(AddressOf ReadCallback, requestDeclare), IAsyncResult)
                allDone.WaitOne()

                Console.Read()
            Catch e As ProtocolViolationException
                Console.WriteLine(("ProtocolViolationException is :" + e.Message))
            Catch e As InvalidOperationException
                Console.WriteLine(("InvalidOperationException is :" + e.Message))
            Catch e As UriFormatException
                Console.WriteLine(("UriFormatExceptionException is :" + e.Message))
            End Try 

        End If  
    End Sub 'Main


    Private Shared Sub ReadCallback(ar As IAsyncResult)
        Try 

            ' State of the request is asynchronous. 
            Dim requestDeclare As RequestDeclare = CType(ar.AsyncState, RequestDeclare)
            Dim myFileWebRequest As FileWebRequest = requestDeclare.myFileWebRequest
            Dim sendToFile As [String] = requestDeclare.userinput

            ' End the Asynchronus request by calling the 'EndGetRequestStream()' method. 
            Dim readStream As Stream = myFileWebRequest.EndGetRequestStream(ar)

            ' Convert the string into byte array. 
            Dim encoder As New ASCIIEncoding()
            Dim byteArray As Byte() = encoder.GetBytes(sendToFile)

            ' Write to the stream.
            readStream.Write(byteArray, 0, sendToFile.Length)
            readStream.Close()
            allDone.Set()


            Console.WriteLine(ControlChars.Cr +"The String you entered was successfully written into the file.")
            Console.WriteLine(ControlChars.Cr +"Press Enter to continue.")

            Catch e As ApplicationException
            Console.WriteLine(("ApplicationException is :" + e.Message))
        End Try 

    End Sub ' ReadCallback 
public __gc class RequestDeclare {
public:
   FileWebRequest*  myFileWebRequest;
   String*  userinput;

   RequestDeclare() {
      myFileWebRequest = 0;
   }
};

__gc class FileWebRequest_reqbeginend
{
public:
   static ManualResetEvent * allDone = new ManualResetEvent(false);

   static void ReadCallback(IAsyncResult* ar) {
      try {
         // State of the request is asynchronous.
         RequestDeclare* requestDeclare = dynamic_cast<RequestDeclare*> (ar->AsyncState);
         FileWebRequest* myFileWebRequest=requestDeclare->myFileWebRequest;
         String*  sendToFile = requestDeclare->userinput;

         // End the Asynchronus request by calling the 'EndGetRequestStream()' method.
         Stream* readStream=myFileWebRequest->EndGetRequestStream(ar);

         // Convert the String* into Byte array.

         ASCIIEncoding* encoder = new ASCIIEncoding();
         Byte byteArray[] = encoder->GetBytes(sendToFile);

         // Write to the stream.
         readStream->Write(byteArray, 0, sendToFile->Length);
         readStream->Close();
         allDone->Set();

         Console::WriteLine(S"\nThe String you entered was successfully written into the file.");
         Console::WriteLine(S"\nPress Enter to continue.");

      } catch (ApplicationException* e) {
         Console::WriteLine(S"ApplicationException is : {0}", e->Message);
      }
   }
};

int main() {
   String* args[] = Environment::GetCommandLineArgs();
   if (args->Length < 2) {
      Console::WriteLine(S"\nPlease enter the file name as command line parameter:");
      Console::WriteLine(S"Usage:FileWebRequest_reqbeginend <systemname>/<sharedfoldername>/<filename>\n");
      Console::WriteLine(S"Example:FileWebRequest_reqbeginend shafeeque/shaf/hello.txt");
   } else {
      try {

         // Place a webrequest.
         WebRequest* myWebRequest= WebRequest::Create(String::Concat(S"file://", args[1]));

         // Create an instance of the 'RequestDeclare' and associate the 'myWebRequest' to it.
         RequestDeclare* requestDeclare = new RequestDeclare();
         requestDeclare->myFileWebRequest = dynamic_cast<FileWebRequest*>(myWebRequest);
         // Set the 'Method' property of 'FileWebRequest' Object* to 'POST' method.
         requestDeclare->myFileWebRequest->Method=S"POST";
         Console::WriteLine(S"Enter the String* you want to write into the file:");
         requestDeclare->userinput = Console::ReadLine();

         // Begin the Asynchronous request for getting file content using 'BeginGetRequestStream()' method .
         IAsyncResult* r = dynamic_cast<IAsyncResult*>
            (requestDeclare->myFileWebRequest->BeginGetRequestStream(new AsyncCallback(0, 
            &FileWebRequest_reqbeginend::ReadCallback), requestDeclare));
         FileWebRequest_reqbeginend::allDone->WaitOne();

         Console::Read();
      } catch (ProtocolViolationException* e) {
         Console::WriteLine(S"ProtocolViolationException is : {0}", e->Message);
      } catch (InvalidOperationException* e) {
         Console::WriteLine(S"InvalidOperationException is : {0}", e->Message);
      } catch (UriFormatException* e) {
         Console::WriteLine(S"UriFormatExceptionException is : {0}", e->Message);
      }
   }
}   

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
Show: