HttpClient.GetAsync Method (String, HttpCompletionOption, CancellationToken)
Sends a GET request to the specified Uri with an HTTP completion option and a cancellation token as an asynchronous operation.
Namespace: System.Net.Http
Assembly: System.Net.Http (in System.Net.Http.dll)
Syntax
'Declaration
Public Function GetAsync ( _
requestUri As String, _
completionOption As HttpCompletionOption, _
cancellationToken As CancellationToken _
) As Task(Of HttpResponseMessage)
'Usage
Dim instance As HttpClient
Dim requestUri As String
Dim completionOption As HttpCompletionOption
Dim cancellationToken As CancellationToken
Dim returnValue As Task(Of HttpResponseMessage)
returnValue = instance.GetAsync(requestUri, _
completionOption, cancellationToken)
public Task<HttpResponseMessage> GetAsync(
string requestUri,
HttpCompletionOption completionOption,
CancellationToken cancellationToken
)
public:
Task<HttpResponseMessage^>^ GetAsync(
String^ requestUri,
HttpCompletionOption completionOption,
CancellationToken cancellationToken
)
member GetAsync :
requestUri:string *
completionOption:HttpCompletionOption *
cancellationToken:CancellationToken -> Task<HttpResponseMessage>
public function GetAsync(
requestUri : String,
completionOption : HttpCompletionOption,
cancellationToken : CancellationToken
) : Task<HttpResponseMessage>
Parameters
- requestUri
Type: System.String
The Uri the request is sent to.
- completionOption
Type: System.Net.Http.HttpCompletionOption
An HTTP completion option value that indicates when the operation should be considered completed.
- cancellationToken
Type: System.Threading.CancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Return Value
Type: System.Threading.Tasks.Task<HttpResponseMessage>
The task object representing the asynchronous operation.
Remarks
This operation will not block. The returned task object will complete after the whole response (including content) is read.
For a complete example of using the HttpClient class, see Calling a Web API From a .NET Client