XblHttpCallGetResponseString

Get the response body string of the HTTP call.

Syntax

HRESULT XblHttpCallGetResponseString(  
         XblHttpCallHandle call,  
         const char** responseString  
)  

Parameters

call   _In_
Type: XblHttpCallHandle

The handle of the HTTP call.

responseString   _Out_
Type: char**

The UTF-8 encoded response body string of the HTTP call. The memory for the returned string pointer remains valid for the life of the XblHttpCallHandle object until XblHttpCallCloseHandle() is called on it.

Return value

Type: HRESULT

Result code for this API operation. Possible values are S_OK, E_INVALIDARG, or E_FAIL.

Remarks

This can only be called after calling XblHttpCallPerformAsync when the HTTP task is completed. This will only be valid if the responsetype passed to PerformAsync was String.

Requirements

Header: http_call_c.h

Library: Microsoft.Xbox.Services.14x.GDK.C.lib

See also

http_call_c