Open topic with navigation

SK_HttpRequest Function

Performs an HTTP request.

Remarks

When sending the request, the HTTP header does not contain a user-agent value.

Syntax

C/C++

SK_ResultCode SK_HttpRequest(SK_ApiContext context, int flags, const char *url, const char *postString, char **response, int *statusCode);

Visual Basic

Declare Function SK_HttpRequest(ByVal context As Long, ByVal flags As Long, ByVal url As String, ByVal postString As String, ByRef response As String, ByRef statusCode As Long) As Long

Arguments

context

The API Context handle.

flags

Any flags passed into this function-call.

url

The URL for which the HTTP request will be performed. The value provided must not begin with http:// or https://, as the protocol used is determined by the context's flags or the flags argument.

postString

For HTTP POST, pass the URL-encoded post data string. For HTTP GET, pass NULL or an empty string.

response

Reference/pointer to a string pointer, which will point to the string which contains the response returned from the server when the call succeeds. The string pointer must be initialized to NULL (0) prior to calling this function.

statusCode

Reference/pointer to an integer, which will point to the HTTP response status code for this request.

Returns

All possible return values are included in the SK_ResultCode enumeration. Return codes to expect include: