HCHttpCallRequestSetRequestBodyString

  • Article

Set the request body string of the HTTP call. This API operation is mutually exclusive with HCHttpCallRequestSetRequestBodyReadFunction and will result in any custom read callbacks that were previously set on this call handle to be ignored.

Syntax

HRESULT HCHttpCallRequestSetRequestBodyString(  
         HCCallHandle call,  
         const char* requestBodyString  
)

Parameters

call   _In_
Type: HCCallHandle

The handle of the HTTP call.

requestBodyString   _In_z_
Type: char*

The UTF-8 encoded request body string of the HTTP call.

Return value

Type: HRESULT

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

Remarks

This must be called prior to calling HCHttpCallPerformAsync.

Requirements

Header: httpClient.h

Library: libHttpClient.141.GSDK.C.lib

See also

httpClient