HCHttpCallResponseGetResponseBodyBytes

Get the response body buffer of the HTTP call. This API operation will fail if a custom write callback was set on this call handle using HCHttpCallResponseSetResponseBodyWriteFunction.

Syntax

HRESULT HCHttpCallResponseGetResponseBodyBytes(  
         HCCallHandle call,  
         size_t bufferSize,  
         uint8_t* buffer,  
         size_t* bufferUsed  
)  

Parameters

call   _In_
Type: HCCallHandle

The handle of the HTTP call.

bufferSize   _In_
Type: size_t

The response body buffer size being passed in.

buffer   _Out_writes_bytes_to_opt_(bufferSize,bufferUsed)
Type: uint8_t

The buffer to be written to.

bufferUsed   _Out_opt_
Type: size_t*

The actual number of bytes written to the buffer.

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 HCHttpCallPerformAsync when the HTTP task is completed.

Requirements

Header: httpClient.h

Library: libHttpClient.141.GSDK.C.lib

See also

httpClient