HttpCurl

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.

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

Set to the specific curl command in the execution plan that failed.

Set to an integer value indicating the reason for failure for the methods DoYourThing and ExaminePlan

Possible values are:

0. No error - the method succeeded or hasn't yet been called.
1. curl command syntax error.
2. HTTP response status code indidcates an authentication (401) or authorization (403) error.
3. HTTP response status code indicates an error, but not an authentication or authorization error.
4. HTTP communications failure.
5. Impossible to derive an execution plan from defined outputs and inputs.
6. A step in the execution plan did not resolve any dependency variables.
7. Failed to get curl data from a local file source (see the note below).
8. If we are within a Chilkat.Js context and don't have permission to read the local filesystem.
9. Chilkat has not been successfully unlocked by previously and successfully calling UnlockBundle.

Note: curl can read data from a local file and send it in a request (usually POST/PUT) using special syntax:

• -d @file.txt → reads the file and sends it as request body (form-style encoding).
• --data-binary @file.bin → sends raw file contents exactly as-is.
• -F "file=@file.txt" → uploads the file as multipart/form-data.

The @ tells curl to load the data from a local file instead of using a literal string.

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.

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.

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.

Indicates the success or failure of the most recent method call: .T. means success, .F. 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.

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

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 .

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

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

Version of the component/library, such as "10.1.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 .T. for success, .F. for failure.

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 .T. for success, .F. for failure.

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 .T. for success, .F. for failure.

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

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

Returns .T. for success, .F. for failure.

Runs a the curl command specified in targetCurl. Returns success (.T.) 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 .T. for success, .F. for failure.

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

Returns .F. on failure

Used for debugging. Returns in json 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.

If no execution plan is possible with the current known inputs and outputs, then json provides information about what is missing and the method returns .F..

Returns .T. for success, .F. for failure.

Returns all defined variables in json.

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

Returns .T. for success, .F. for failure.

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

Returns .T. for success, .F. for failure.

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

Returns .T. for success, .F. for failure.

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

Returns .T. for success, .F. for failure.

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

Returns .T. for success, .F. for failure.

Retrieves the current value of the variable specified by varName.

Returns .F. on failure

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

Returns .T. for success, .F. for failure.

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 .T. for success, .F. for failure.

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 .T. for success, .F. for failure.

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