HttpRequest Tcl Reference Documentation

HttpRequest

Current Version: 9.5.0.73

Represents a complete HTTP request.

Object Creation

set myHttpRequest [new CkHttpRequest]

Properties

Boundary
string
# ckStr is a CkString
CkHttpRequest_get_Boundary $myHttpRequest $ckStr
set strVal [CkHttpRequest_get_boundary $myHttpRequest]
CkHttpRequest_put_Boundary $myHttpRequest $strVal
Introduced in version 9.5.0.49

Sets an explicit boundary string to be used in multipart/form-data requests. If no Boundary is set, then a boundary string is automaticaly generated as needed during the sending of a request.

More Information and Examples
top
Charset
string
# ckStr is a CkString
CkHttpRequest_get_Charset $myHttpRequest $ckStr
set strVal [CkHttpRequest_get_charset $myHttpRequest]
CkHttpRequest_put_Charset $myHttpRequest $strVal

Controls the character encoding used for HTTP request parameters for POST requests. The default value is the ANSI charset of the computer. The charset should match the charset expected by the form target.

The "charset" attribute is only included in the Content-Type header of the request if the SendCharset property is set to 1.

top
ContentType
string
# ckStr is a CkString
CkHttpRequest_get_ContentType $myHttpRequest $ckStr
set strVal [CkHttpRequest_get_contentType $myHttpRequest]
CkHttpRequest_put_ContentType $myHttpRequest $strVal

The ContentType property sets the "Content-Type" header field, and identifies the content-type of the HTTP request body. Common values are:

application/x-www-form-urlencoded
multipart/form-data
application/json
application/xml
If ContentType is set equal to the empty string, then no Content-Type header is included in the HTTP request.

top
DebugLogFilePath
string
# ckStr is a CkString
CkHttpRequest_get_DebugLogFilePath $myHttpRequest $ckStr
set strVal [CkHttpRequest_get_debugLogFilePath $myHttpRequest]
CkHttpRequest_put_DebugLogFilePath $myHttpRequest $strVal

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
EntireHeader
string
# ckStr is a CkString
CkHttpRequest_get_EntireHeader $myHttpRequest $ckStr
set strVal [CkHttpRequest_get_entireHeader $myHttpRequest]
CkHttpRequest_put_EntireHeader $myHttpRequest $strVal

Composes and returns the entire MIME header of the HTTP request.

top
HttpVerb
string
# ckStr is a CkString
CkHttpRequest_get_HttpVerb $myHttpRequest $ckStr
set strVal [CkHttpRequest_get_httpVerb $myHttpRequest]
CkHttpRequest_put_HttpVerb $myHttpRequest $strVal

The HttpVerb property should be set to the name of the HTTP method that appears on the "start line" of an HTTP request, such as GET, POST, PUT, DELETE, etc. It is also possible to use the various WebDav verbs such as PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, UNLOCK, etc. In general, the HttpVerb may be set to anything, even custom verbs recognized by a custom server-side app.

top
HttpVersion
string
# ckStr is a CkString
CkHttpRequest_get_HttpVersion $myHttpRequest $ckStr
set strVal [CkHttpRequest_get_httpVersion $myHttpRequest]
CkHttpRequest_put_HttpVersion $myHttpRequest $strVal

The HTTP version in the request header. Defaults to "1.1".

top
LastErrorHtml
string
# ckStr is a CkString
CkHttpRequest_get_LastErrorHtml $myHttpRequest $ckStr
set strVal [CkHttpRequest_get_lastErrorHtml $myHttpRequest]

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
string
# ckStr is a CkString
CkHttpRequest_get_LastErrorText $myHttpRequest $ckStr
set strVal [CkHttpRequest_get_lastErrorText $myHttpRequest]

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
string
# ckStr is a CkString
CkHttpRequest_get_LastErrorXml $myHttpRequest $ckStr
set strVal [CkHttpRequest_get_lastErrorXml $myHttpRequest]

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
boolean 1/0
set boolVal [CkHttpRequest_get_LastMethodSuccess $myHttpRequest]
CkHttpRequest_put_LastMethodSuccess $myHttpRequest $boolVal
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = 1 and failure = 0.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
NumHeaderFields
integer
set intVal [CkHttpRequest_get_NumHeaderFields $myHttpRequest]

Returns the number of request header fields.

top
NumParams
integer
set intVal [CkHttpRequest_get_NumParams $myHttpRequest]

Returns the number of query parameters.

More Information and Examples
top
Path
string
# ckStr is a CkString
CkHttpRequest_get_Path $myHttpRequest $ckStr
set strVal [CkHttpRequest_get_path $myHttpRequest]
CkHttpRequest_put_Path $myHttpRequest $strVal

The path of the resource requested. A path of "/" indicates the default document for a domain.

More Information and Examples
top
SendCharset
boolean 1/0
set boolVal [CkHttpRequest_get_SendCharset $myHttpRequest]
CkHttpRequest_put_SendCharset $myHttpRequest $boolVal

Controls whether the charset is explicitly included in the content-type header field of the HTTP POST request. The default value of this property is 0.

top
Utf8
boolean 1/0
set boolVal [CkHttpRequest_get_Utf8 $myHttpRequest]
CkHttpRequest_put_Utf8 $myHttpRequest $boolVal

When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.

top
VerboseLogging
boolean 1/0
set boolVal [CkHttpRequest_get_VerboseLogging $myHttpRequest]
CkHttpRequest_put_VerboseLogging $myHttpRequest $boolVal

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.

top
Version
string
# ckStr is a CkString
CkHttpRequest_get_Version $myHttpRequest $ckStr
set strVal [CkHttpRequest_get_version $myHttpRequest]

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

top

Methods

AddBytesForUpload
# name is a string
# remoteFileName is a string
# byteData is a CkByteData
set status [CkHttpRequest_AddBytesForUpload $name $remoteFileName $byteData]

Adds a file to an upload request where the contents of the file come from an in-memory byte array. To create a file upload request, call UseUpload and then call AddBytesForUpload, AddStringForUpload, or AddFileForUpload for each file to be uploaded.

name is an arbitrary name. (In HTML, it is the form field name of the input tag.)
remoteFileName is the name of the file to be created on the HTTP server.
byteData contains the contents (bytes) to be uploaded.

Returns 1 for success, 0 for failure.

top
AddBytesForUpload2
# name is a string
# remoteFileName is a string
# byteData is a CkByteData
# contentType is a string
set status [CkHttpRequest_AddBytesForUpload2 $name $remoteFileName $byteData $contentType]

Same as AddBytesForUpload, but allows the Content-Type header field to be directly specified. (Otherwise, the Content-Type header is automatically determined based on the remoteFileName's file extension.)

Returns 1 for success, 0 for failure.

top
AddFileForUpload
# name is a string
# filePath is a string
set status [CkHttpRequest_AddFileForUpload $name $filePath]

Adds a file to an upload request. To create a file upload request, call UseUpload and then call AddFileForUpload, AddBytesForUpload, or AddStringForUpload for each file to be uploaded. This method does not read the file into memory. When the upload occurs, the data is streamed directly from the file, thus allowing for very large files to be uploaded without consuming large amounts of memory.

name is an arbitrary name. (In HTML, it is the form field name of the input tag.)
filePath is the path to an existing file in the local filesystem.

Returns 1 for success, 0 for failure.

More Information and Examples
top
AddFileForUpload2
# name is a string
# filePath is a string
# contentType is a string
set status [CkHttpRequest_AddFileForUpload2 $name $filePath $contentType]

Same as AddFileForUpload, but allows the Content-Type header field to be directly specified. (Otherwise, the Content-Type header is automatically determined based on the file extension.)

name is an arbitrary name. (In HTML, it is the form field name of the input tag.)
filePath is the path to an existing file in the local filesystem.

Returns 1 for success, 0 for failure.

More Information and Examples
top
AddHeader
# name is a string
# value is a string
CkHttpRequest_AddHeader $name $value

Adds a request header to the HTTP request. If a header having the same field name is already present, this method replaces it.

Note: Never explicitly set the Content-Length header field. Chilkat will automatically compute the correct length and add the Content-Length header to all POST, PUT, or any other request where the Content-Length needs to be specified. (GET requests always have a 0 length body, and therefore never need a Content-Length header field.)

More Information and Examples
top
AddMwsSignature
# domain is a string
# mwsSecretKey is a string
set status [CkHttpRequest_AddMwsSignature $domain $mwsSecretKey]
Introduced in version 9.5.0.66

Computes the Amazon MWS signature using the mwsSecretKey and adds the "Signature" parameter to the request. This method should be called for all Amazon Marketplace Web Service (Amazon MWS) HTTP requests. It should be called after all request parameters have been added.

The domain should be the domain of the request, such as one of the following:

  • mws.amazonservices.com
  • mws-eu.amazonservices.com
  • mws.amazonservices.in
  • mws.amazonservices.com.cn
  • mws.amazonservices.jp

Note: This method automatically adds or replaces the existing Timestamp parameter to the current system date/time.

Returns 1 for success, 0 for failure.

top
AddParam
# name is a string
# value is a string
CkHttpRequest_AddParam $name $value

Adds a request query parameter (name/value pair) to the HTTP request. The name and value strings passed to this method should not be URL encoded.

top
AddStringForUpload
# name is a string
# filename is a string
# strData is a string
# charset is a string
set status [CkHttpRequest_AddStringForUpload $name $filename $strData $charset]

Same as AddFileForUpload, but the upload data comes from an in-memory string instead of a file.

Returns 1 for success, 0 for failure.

top
AddStringForUpload2
# name is a string
# filename is a string
# strData is a string
# charset is a string
# contentType is a string
set status [CkHttpRequest_AddStringForUpload2 $name $filename $strData $charset $contentType]

Same as AddStringForUpload, but allows the Content-Type header field to be directly specified. (Otherwise, the Content-Type header is automatically determined based on the filename's file extension.)

Returns 1 for success, 0 for failure.

top
AddSubHeader
# index is an integer
# name is a string
# value is a string
set status [CkHttpRequest_AddSubHeader $index $name $value]
Introduced in version 9.5.0.55

Adds a request header to the Nth sub-header of the HTTP request. If a header having the same field name is already present, this method replaces it.

Returns 1 for success, 0 for failure.

top
GenerateRequestFile
# path is a string
set status [CkHttpRequest_GenerateRequestFile $path]
Introduced in version 9.5.0.64

The same as GenerateRequestText, except the generated request is written to the file specified by path.

Returns 1 for success, 0 for failure.

top
GenerateRequestText
# outStr is a CkString (output)
set status [CkHttpRequest_GenerateRequestText $outStr]
set retStr [CkHttpRequest_generateRequestText $myHttpRequest]

Returns the request text that would be sent if Http.SynchronousRequest was called.

Returns 1 for success, 0 for failure.

top
GetHeaderField
# name is a string
# outStr is a CkString (output)
set status [CkHttpRequest_GetHeaderField $name $outStr]
set retStr [CkHttpRequest_getHeaderField $myHttpRequest $name]

Returns the value of a request header field.

Returns 1 for success, 0 for failure.

top
GetHeaderName
# index is an integer
# outStr is a CkString (output)
set status [CkHttpRequest_GetHeaderName $index $outStr]
set retStr [CkHttpRequest_getHeaderName $myHttpRequest $index]

Returns the Nth request header field name. Indexing begins at 0, and the number of request header fields is specified by the NumHeaderFields property.

Returns 1 for success, 0 for failure.

top
GetHeaderValue
# index is an integer
# outStr is a CkString (output)
set status [CkHttpRequest_GetHeaderValue $index $outStr]
set retStr [CkHttpRequest_getHeaderValue $myHttpRequest $index]

Returns the Nth request header field value. Indexing begins at 0, and the number of request header fields is specified by the NumHeaderFields property.

Returns 1 for success, 0 for failure.

top
GetParam
# name is a string
# outStr is a CkString (output)
set status [CkHttpRequest_GetParam $name $outStr]
set retStr [CkHttpRequest_getParam $myHttpRequest $name]

Returns a request query parameter value by name.

Returns 1 for success, 0 for failure.

top
GetParamName
# index is an integer
# outStr is a CkString (output)
set status [CkHttpRequest_GetParamName $index $outStr]
set retStr [CkHttpRequest_getParamName $myHttpRequest $index]

Returns the Nth request query parameter field name. Indexing begins at 0, and the number of request query parameter fields is specified by the NumParams property.

Returns 1 for success, 0 for failure.

More Information and Examples
top
GetParamValue
# index is an integer
# outStr is a CkString (output)
set status [CkHttpRequest_GetParamValue $index $outStr]
set retStr [CkHttpRequest_getParamValue $myHttpRequest $index]

Returns the Nth request query parameter field value. Indexing begins at 0, and the number of request query parameter fields is specified by the NumParams property.

Returns 1 for success, 0 for failure.

More Information and Examples
top
GetUrlEncodedParams
# outStr is a CkString (output)
set status [CkHttpRequest_GetUrlEncodedParams $outStr]
set retStr [CkHttpRequest_getUrlEncodedParams $myHttpRequest]

Returns the request parameters in URL encoded form (i.e. in the exact form that would be sent if the ContentType property was application/x-www-form-urlencoded). For example, if a request has two params: param1="abc 123" and param2="abc-123", then GetUrlEncodedParams would return "abc+123

Returns 1 for success, 0 for failure.

top
LoadBodyFromBd
# requestBody is a CkBinData
set status [CkHttpRequest_LoadBodyFromBd $requestBody]
Introduced in version 9.5.0.67

Uses the contents of the requestBody as the HTTP request body.

Returns 1 for success, 0 for failure.

top
LoadBodyFromBytes
# byteData is a CkByteData
set status [CkHttpRequest_LoadBodyFromBytes $byteData]

The HTTP protocol is such that all HTTP requests are MIME. For non-multipart requests, this method may be called to set the MIME body of the HTTP request to the exact contents of the byteData.
Note: A non-multipart HTTP request consists of (1) the HTTP start line, (2) MIME header fields, and (3) the MIME body. This method sets the MIME body.

Returns 1 for success, 0 for failure.

top
LoadBodyFromFile
# filePath is a string
set status [CkHttpRequest_LoadBodyFromFile $filePath]

The HTTP protocol is such that all HTTP requests are MIME. For non-multipart requests, this method may be called to set the MIME body of the HTTP request to the exact contents of filePath.
Note: A non-multipart HTTP request consists of (1) the HTTP start line, (2) MIME header fields, and (3) the MIME body. This method sets the MIME body.

Returns 1 for success, 0 for failure.

top
LoadBodyFromSb
# requestBody is a CkStringBuilder
# charset is a string
set status [CkHttpRequest_LoadBodyFromSb $requestBody $charset]
Introduced in version 9.5.0.67

Uses the contents of the requestBody as the HTTP request body. The charset indicates the binary representation of the string, such as "utf-8", "utf-16", "iso-8859-*", "windows-125*", etc. Any of the character encodings supported at the link below are valid.

Returns 1 for success, 0 for failure.

More Information and Examples
top
LoadBodyFromString
# bodyStr is a string
# charset is a string
set status [CkHttpRequest_LoadBodyFromString $bodyStr $charset]

The HTTP protocol is such that all HTTP requests are MIME. For non-multipart requests, this method may be called to set the MIME body of the HTTP request to the exact contents of bodyStr.
Note: A non-multipart HTTP request consists of (1) the HTTP start line, (2) MIME header fields, and (3) the MIME body. This method sets the MIME body.

charset indicates the charset, such as "utf-8" or "iso-8859-1", to be used. The HTTP body will contain the bodyStr converted to this character encoding.

Returns 1 for success, 0 for failure.

More Information and Examples
top
RemoveAllParams
CkHttpRequest_RemoveAllParams

Removes all request parameters.

More Information and Examples
top
RemoveHeader
# name is a string
set status [CkHttpRequest_RemoveHeader $name]

Removes all occurrences of a HTTP request header field. Always returns 1.

Returns 1 for success, 0 for failure.

top
RemoveParam
# name is a string
CkHttpRequest_RemoveParam $name

Removes a single HTTP request parameter by name.

More Information and Examples
top
SaveLastError
# path is a string
set status [CkHttpRequest_SaveLastError $path]

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns 1 for success, 0 for failure.

top
SetFromUrl
# url is a string
CkHttpRequest_SetFromUrl $url

Parses a URL and sets the Path and query parameters (NumParams, GetParam, GetParamName, GetParamValue).

More Information and Examples
top
StreamBodyFromFile
# filePath is a string
set status [CkHttpRequest_StreamBodyFromFile $filePath]

Useful for sending HTTP requests where the body is a very large file. For example, to send an XML HttpRequest containing a very large XML document, one would set the HttpVerb = "POST", the ContentType = "text/xml", and then call StreamBodyFromFile to indicate that the XML body of the request is to be streamed directly from a file. When the HTTP request is actually sent, the body is streamed directly from the file, and thus the file never needs to be loaded in its entirety in memory.

Returns 1 for success, 0 for failure.

More Information and Examples
top
StreamChunkFromFile
# path is a string
# offset is a string
# numBytes is a string
set status [CkHttpRequest_StreamChunkFromFile $path $offset $numBytes]
Introduced in version 9.5.0.55

This method is the same as StreamBodyFromFile, but allows for an offset and number of bytes to be specified. The offset and numBytes are integers passed as strings.

Returns 1 for success, 0 for failure.

top
UseGet
CkHttpRequest_UseGet
This method is deprecated. It will be removed in a future version.

Makes the HttpRequest a GET request.

Important: This method is deprecated. An application should instead set the HttpVerb property equal to "GET", and the ContentType equal to an empty string (because GET requests have no request body).

top
UseHead
CkHttpRequest_UseHead
This method is deprecated. It will be removed in a future version.

Makes the HttpRequest a HEAD request.

Important: This method is deprecated. An application should instead set the HttpVerb property equal to "HEAD", and the ContentType equal to an empty string (because HEAD requests have no body).

top
UsePost
CkHttpRequest_UsePost
This method is deprecated. It will be removed in a future version.

Makes the HttpRequest a POST request that uses the "application/x-www-form-urlencoded" content type.

Important: This method is deprecated. An application should instead set the HttpVerb property equal to "POST", and the ContentType equal to "application/x-www-form-urlencoded".

top
UsePostMultipartForm
CkHttpRequest_UsePostMultipartForm
This method is deprecated. It will be removed in a future version.

Makes the HttpRequest a POST request that uses the "multipart/form-data" content type.

Important: This method is deprecated. An application should instead set the HttpVerb property equal to "POST", and the ContentType equal to "multipart/form-data".

top
UsePut
CkHttpRequest_UsePut
This method is deprecated. It will be removed in a future version.

Makes the HttpRequest a PUT request.

Important: This method is deprecated. An application should instead set the HttpVerb property equal to "PUT", and the ContentType equal to "application/x-www-form-urlencoded".

top
UseUpload
CkHttpRequest_UseUpload
This method is deprecated. It will be removed in a future version.

Makes the HttpRequest a POST request that uses the "multipart/form-data" content type. To create a file upload request, call UseUpload and then call AddFileForUpload for each file to be uploaded.

Important: This method is deprecated. An application should instead set the HttpVerb property equal to "POST", and the ContentType equal to "multipart/form-data".

top
UseUploadPut
CkHttpRequest_UseUploadPut
This method is deprecated. It will be removed in a future version.

Makes the HttpRequest a PUT request that uses the "multipart/form-data" content type. To create a file upload request (using the PUT verb), call UseUploadPut and then call AddFileForUpload for each file to be uploaded.

Important: This method is deprecated. An application should instead set the HttpVerb property equal to "PUT", and the ContentType equal to "multipart/form-data".

top
UseXmlHttp
# xmlBody is a string
CkHttpRequest_UseXmlHttp $xmlBody
This method is deprecated. It will be removed in a future version.

Makes the HttpRequest a POST request using the "application/xml" content type. The request body is set to the XML string passed to this method.

Important: This method is deprecated. An application should instead set the HttpVerb property equal to "POST", the ContentType equal to "text/xml", and the request body should contain the XML document text.

top