HttpCurl PureBasic Reference Documentation

HttpCurl

Current Version: 11.4.0

Requires Chilkat Bundle License

A class for running curl commands within your application. Mirrors the curl command syntax. It is not derived from curl/libcurl, and does not wrap libcurl.

Object Creation

obj.i = CkHttpCurl::ckCreate()

; Make sure to dispose of the object when finished like this:
CkHttpCurl::ckDispose(obj);

Properties

DebugLogFilePath

Declare.s ckDebugLogFilePath(obj.i)
Declare setCkDebugLogFilePath(obj.i, value.s)

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

More Information and Examples

Example showing how to use DebugLogFilePath.

EnableBodyVars

Declare.i ckEnableBodyVars(obj.i)
Declare setCkEnableBodyVars(obj.i, value.i)

Introduced in version 11.5.0

Enables variable substitution in the body of the request. The default value is 1.

More Information and Examples

curl with Variable Substitution in the Request Body

LastErrorHtml

Declare.s ckLastErrorHtml(obj.i) ; (read-only)

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastErrorText

Declare.s ckLastErrorText(obj.i) ; (read-only)

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

Declare.s ckLastErrorXml(obj.i) ; (read-only)

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastMethodSuccess

Declare.i ckLastMethodSuccess(obj.i)
Declare setCkLastMethodSuccess(obj.i, value.i)

Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

ResponseBodyStr

Declare.s ckResponseBodyStr(obj.i) ; (read-only)

Introduced in version 11.5.0

Returns the HTTP response body from the last call to DoYourThing .

ResponseFilePath

Declare.s ckResponseFilePath(obj.i)
Declare setCkResponseFilePath(obj.i, value.s)

Introduced in version 11.5.0

Set this property to the path of a file to stream the response body to a file. If the response is streamed to a file, it will not be available in ResponseBodyStr , GetResponseSb , or GetResponseBd .

StatusCode

Declare.i ckStatusCode(obj.i) ; (read-only)

Introduced in version 11.5.0

Returns the HTTP status code from the last call to DoYourThing. A value of 0 indicates no response header was received.

VerboseLogging

Declare.i ckVerboseLogging(obj.i)
Declare setCkVerboseLogging(obj.i, value.i)

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version

Declare.s ckVersion(obj.i) ; (read-only)

Version of the component/library, such as "10.1.0"

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AddFunction

Declare.i ckAddFunction(obj.i, funcName.s, curl.s)

Introduced in version 11.5.0

Adds a named curl function that can be used in dependency resolution. Inputs required by the curl function are indicated by the variable names enclosed in {{ and }}. Outputs are defined in one or more calls to AddOutput .

Returns 1 for success, 0 for failure.

AddOutput

Declare.i ckAddOutput(obj.i, funcName.s, jsonPath.s, varName.s)

Introduced in version 11.5.0

Adds a defined output for a dependency resolution curl function previously defined by calling AddFunction. The jsonPath is the JSON path in the JSON response body where the varName's value is located.

Returns 1 for success, 0 for failure.

AddTargetOutput

Declare ckAddTargetOutput(obj.i, jsonPath.s, varName.s)

Introduced in version 11.5.0

Adds an automatically mapped variable for the target curl command. When a JSON response is received from a curl request, the value at the JSON path specified by jsonPath is extracted (if present) and assigned to the variable named by varName.

This is useful in common workflows where one request returns an identifier (such as an `id`) that must be reused in a subsequent curl request.

Returns 1 for success, 0 for failure.

ClearTargetOutput

Declare ckClearTargetOutput(obj.i, varName.s)

Introduced in version 11.5.0

Clears (undefines) the target output for the specified varName. If varName equals "*", then all target outputs are cleared.

ClearVar

Declare ckClearVar(obj.i, varName.s)

Introduced in version 11.5.0

Undefines the variable with the specified name. If varName equals "*", then all variables are cleared.

Returns 1 for success, 0 for failure.

DoYourThing

Declare.i ckDoYourThing(obj.i, targetCurl.s)

Introduced in version 11.5.0

Runs a the curl command specified in targetCurl. Returns success (1) if a response was received, in which case the response status code will be available in StatusCode and the content of the response body will be available in one of two places:

If ResponseFilePath is non-empty, the response body was streamed to the specified file path.
If ResponseFilePath is empty, the response body can be retrieved via ResponseBodyStr , GetResponseSb , or GetResponseBd . Binary responses should only be retrieved via ResponseBodyBd .

Assuming the HTTP response is JSON, the target outputs (variables) specified by prior calls to AddTargetOutput will be populated by applying each variable's JSON path to the response JSON.

Returns 1 for success, 0 for failure.

DoYourThingAsync ⁽¹⁾

Declare.i ckDoYourThingAsync(obj.i, targetCurl.s)

Introduced in version 11.5.0

Creates an asynchronous task to call the DoYourThing method with the arguments provided.

Returns 0 on failure

ExaminePlan

Declare.s ckExaminePlan(obj.i, curl.s)

Introduced in version 11.5.0

Used for debugging. Returns a string that provides information about the plan of execution that would occur for the curl based on the variables that are either unknown or already known. The plan of execution is what would occur if DoYourThing was called with the current state of knowledge.

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

GetAllVars

Declare ckGetAllVars(obj.i, json.i)

Introduced in version 11.5.0

Returns all defined variables in json.

GetResponseBd

Declare.i ckGetResponseBd(obj.i, bd.i)

Introduced in version 11.5.0

Writes to bd the HTTP response body from the last call to DoYourThing.

Returns 1 for success, 0 for failure.

GetResponseJarr

Declare.i ckGetResponseJarr(obj.i, jarr.i)

Introduced in version 11.5.0

Writes to jarr the HTTP response body from the last call to DoYourThing.

Returns 1 for success, 0 for failure.

GetResponseJson

Declare.i ckGetResponseJson(obj.i, json.i)

Introduced in version 11.5.0

Writes to json the HTTP response body from the last call to DoYourThing.

Returns 1 for success, 0 for failure.

GetResponseSb

Declare.i ckGetResponseSb(obj.i, sb.i)

Introduced in version 11.5.0

Writes to sb the HTTP response body from the last call to DoYourThing.

Returns 1 for success, 0 for failure.

GetResponseXml

Declare.i ckGetResponseXml(obj.i, xml.i)

Introduced in version 11.5.0

Writes to xml the HTTP response body from the last call to DoYourThing.

Returns 1 for success, 0 for failure.

GetVar

Declare.s ckGetVar(obj.i, varName.s)

Introduced in version 11.5.0

Retrieves the current value of the variable specified by varName.

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

SetAuth

Declare.i ckSetAuth(obj.i, json.i)

Introduced in version 11.5.0

Sets authorization information that is applied to all calls to DoYourThing . See the examples below for details.

Returns 1 for success, 0 for failure.

SetVar

Declare ckSetVar(obj.i, varName.s, varValue.s)

Introduced in version 11.5.0

Sets the value of a variable to be replaced in curl commands. Variable names are enclosed in {{ and }} and can occur in the path, query params, or the body of the request.

Returns 1 for success, 0 for failure.

More Information and Examples

curl with Path Variables and Query Params curl with Variable Substitution in the Request Body

ToRawRequest

Declare.i ckToRawRequest(obj.i, curlCommand.s, sb.i)

Introduced in version 11.5.0

Used for debugging purposes. This method behaves the same as DoYourThing , but only converts the curlCommand to an HTTP request message in sb containing the full structure:

start line
headers
optional body or multipart body

It does not actually send the HTTP request.

Returns 1 for success, 0 for failure.

VarDefined

Declare.i ckVarDefined(obj.i, varName.s)

Introduced in version 11.5.0

Returns 1 if the varName is defined, otherwise returns 0. Setting varName to "!" checks whether all target output variables have been defined. It returns 1 if every target output is set, and 0 if any are missing.