Http PureBasic Reference Documentation

Http

Current Version: 10.0.0

Requires Chilkat Bundle License

Class for sending HTTP requests and receiving server responses.

Supports GET, POST, HEAD, PUT, DELETE, WebDav, and custom HTTP request methods.
HTTP Authentication: Basic, NTLM, Digest, Negotiate
HTTPS (SSL/TLS) with client-side certificate capabilities.
Cookie caching, auto-resend, persisting to XML files.
Content caching.
Supports HTTP proxies
Auto-follow redirects if desired.
Amazon S3 methods.
XML HTTP Request
HTTP file upload capabilities
Asynchronous features -- putting HTTP requests in background threads.
Supports SOCK5/SOCKS4 proxies.
IPv6 capable.

Object Creation

obj.i = CkHttp::ckCreate()

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

Properties

AbortCurrent

Declare.i ckAbortCurrent(obj.i)
Declare setCkAbortCurrent(obj.i, value.i)

Introduced in version 9.5.0.58

When set to 1, causes the currently running method to abort. Methods that always finish quickly (i.e.have no length file operations or network communications) are not affected. If no method is running, then this property is automatically reset to 0 when the next method is called. When the abort occurs, this property is reset to 0. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

Accept

Declare.s ckAccept(obj.i)
Declare setCkAccept(obj.i, value.s)

The Accept header field to be automatically included with GET requests issued by QuickGet or QuickGetStr. The default value is "*/*".

AcceptCharset

Declare.s ckAcceptCharset(obj.i)
Declare setCkAcceptCharset(obj.i, value.s)

The Accept-Charset header field to be automatically included with GET requests issued by QuickGet or QuickGetStr. The default value is the empty string, which means no Accept-Charset header is included.

AcceptLanguage

Declare.s ckAcceptLanguage(obj.i)
Declare setCkAcceptLanguage(obj.i, value.s)

The Accept-Language header field to be automatically included with GET requests issued by QuickGet or QuickGetStr. The default value is "en-us,en;q=0.5".

AllowGzip

Declare.i ckAllowGzip(obj.i)
Declare setCkAllowGzip(obj.i, value.i)

Controls whether the "Accept-Encoding: gzip" header is added to HTTP requests sent via any method that sends an HTTP request without using the HttpRequest object (such as QuickGetStr). If 0, then the empty Accept-Encoding header is added which means the server response should contain the uncompressed content. The default value is 1, which means the server, if it chooses, may send a gzipped response.

AllowHeaderFolding

Declare.i ckAllowHeaderFolding(obj.i)
Declare setCkAllowHeaderFolding(obj.i, value.i)

Introduced in version 9.5.0.63

If this property is set to 0, then no MIME header folding will be automatically applied to any request header. The default is 1.

AuthSignature

Declare.s ckAuthSignature(obj.i)
Declare setCkAuthSignature(obj.i, value.s)

Introduced in version 9.5.0.89

If set, then automatically adds the Authorization: Signature keyId="...", algorithm="...", headers="...", signature="..." header to all requests. This property should be set to a JSON string containing the information needed to compute and automatically add the HTTP Signature. See the example(s) below.

More Information and Examples

Refinitiv World-Check One - Get Top Level Groups

AuthToken

Declare.s ckAuthToken(obj.i)
Declare setCkAuthToken(obj.i, value.s)

Introduced in version 9.5.0.67

If set, then automatically adds the "Authorization: Bearer " header to all requests. (If you have an OAuth2 access token, set this property equal to the OAuth2 access token string. Note: For OAuth1 (older) tokens, use the OAuthTOken property. )

More Information and Examples

Using the OAuth2 Authorization Token in REST API Calls

AutoAddHostHeader

Declare.i ckAutoAddHostHeader(obj.i)
Declare setCkAutoAddHostHeader(obj.i, value.i)

If set to true, the "Host" header field will automatically be added to the request header for any QuickGet or QuickGetStr method calls. The value of the Host header field is taken from the hostname part of the URL passed to QuickGet/QuickGetStr.

AwsAccessKey

Declare.s ckAwsAccessKey(obj.i)
Declare setCkAwsAccessKey(obj.i, value.s)

The AWS Access Key to be used with the Amazon S3 methods listed below.

AwsEndpoint

Declare.s ckAwsEndpoint(obj.i)
Declare setCkAwsEndpoint(obj.i, value.s)

The regional endpoint (domain) to be used for Amazon S3 method calls. The default value is "s3.amazonaws.com". This can be set to any valid Amazon S3 endpoint, such as "s3-eu-west-1.amazonaws.com", or the endpoints for S3-API compatible services from other different providers.

More Information and Examples

Using an S3 Compatible Storage Provider

AwsRegion

Declare.s ckAwsRegion(obj.i)
Declare setCkAwsRegion(obj.i, value.s)

Introduced in version 9.5.0.56

The AWS (S3) region, such as "us-east-1", "us-west-2", "eu-west-1", "eu-central-1", etc. This propery defaults to "us-east-1". It is only used when the AwsSignatureVersion property is set to 4. When the AwsSignatureVersion property is set to 2, then this property is unused.

AwsSecretKey

Declare.s ckAwsSecretKey(obj.i)
Declare setCkAwsSecretKey(obj.i, value.s)

The AWS Secret Key to be used with the Amazon S3 methods listed below.

AwsSessionToken

Declare.s ckAwsSessionToken(obj.i)
Declare setCkAwsSessionToken(obj.i, value.s)

Introduced in version 9.5.0.95

This is only used if a set of temporary security credentials were obtained by calling the AssumeRole action of the AWS Security Token Service.

AwsSignatureVersion

Declare.i ckAwsSignatureVersion(obj.i)
Declare setCkAwsSignatureVersion(obj.i, value.i)

Introduced in version 9.5.0.56

Selects the AWS Signature Version algorithm. The default value is 4. May be set to 2 to select AWS Signature Version 2. (The only valid choices are 2 and 4.)

AwsSubResources

Declare.s ckAwsSubResources(obj.i)
Declare setCkAwsSubResources(obj.i, value.s)

The AWS sub-resources to be used with the Amazon S3 methods listed below.

If the S3 request needs to address a sub-resource, like ?versioning, ?policy, ?location, ?acl, or ?torrent, or ?versionid append the sub-resource and its value if it has one. Note that in case of multiple sub-resources, sub-resources must be lexicographically sorted by sub-resource name and separated by '&'. e.g. "acl&versionId=value"

The list of sub-resources that can be included are: acl, location, logging, notification, partNumber, policy, requestPayment, torrent, uploadId, uploads, versionId, versioning, versions and website.

BandwidthThrottleDown

Declare.i ckBandwidthThrottleDown(obj.i)
Declare setCkBandwidthThrottleDown(obj.i, value.i)

Introduced in version 9.5.0.49

If non-zero, limits (throttles) the download bandwidth to approximately this maximum number of bytes per second. The default value of this property is 0.

BandwidthThrottleUp

Declare.i ckBandwidthThrottleUp(obj.i)
Declare setCkBandwidthThrottleUp(obj.i, value.i)

Introduced in version 9.5.0.49

If non-zero, limits (throttles) the upload bandwidth to approximately this maximum number of bytes per second. The default value of this property is 0.

BasicAuth

Declare.i ckBasicAuth(obj.i)
Declare setCkBasicAuth(obj.i, value.i)

If HTTP basic authentication is needed, this property must be set to 1. The HTTP protocol allows for several different types of authentication schemes, such as NTLM, Digest, OAuth1, etc. A given server will support (or allow) certain authentication schemes (also known as authentication methods). Except for the "Basic" authentication method, the other forms of authentication do not involve sending the login and password in plain unencrypted text over the connection. The Basic authentication method is insecure in that it sends the login/password for all to see. If the connection is SSL/TLS, then this might be considered OK. Chilkat takes the safe approach and will not allow Basic authentication unless this property has been explicitly set to 1. The default value of this property is 0.

Note: It is not required to know the authentication methods accepted by the server beforehand (except for the case of Basic authentication). When authentication is required, Chilkat will first send the request without the Authorization header, receive back the 401 Authorization Required response along with information about what authentication methods are accepted, and then re-send with an accepted authentication method. If the authentication method is known in advance, then an application may set the appropriate property, such as NtlmAuth to 1 so that the extra (internal) round-trip is not required.

Note: The login and password is sent using the utf-8 byte representation. Some servers expect the ANSI byte representation (typically Windows-1252). Starting in Chilkat v9.5.0.87, to send the login/password using ANSI, add the "AnsiLogin" keyword to the UncommonOptions property.

More Information and Examples

HTTP Basic Authentication Test

ClientIpAddress

Declare.s ckClientIpAddress(obj.i)
Declare setCkClientIpAddress(obj.i, value.s)

The IP address to use for computers with multiple network interfaces or IP addresses. For computers with a single network interface (i.e. most computers), this property should not be set. For multihoming computers, the default IP address is automatically used if this property is not set.

The IP address is a string such as in dotted notation using numbers, not domain names, such as "165.164.55.124".

More Information and Examples

Important Bind to Adapter Notes for Windows

ConnectFailReason

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

Introduced in version 9.5.0.56

This property will be set to the status of the last HTTP connection made (or failed to be made) by any HTTP method.

Possible values are:

0 = success

Normal (non-TLS) sockets:
1 = empty hostname
2 = DNS lookup failed
3 = DNS timeout
4 = Aborted by application.
5 = Internal failure.
6 = Connect Timed Out
7 = Connect Rejected (or failed for some other reason)
50 = HTTP proxy authentication failure.
98 = Async operation in progress.
99 = Product is not unlocked.

SSL/TLS:
100 = TLS internal error.
101 = Failed to send client hello.
102 = Unexpected handshake message.
103 = Failed to read server hello.
104 = No server certificate.
105 = Unexpected TLS protocol version.
106 = Server certificate verify failed (the server certificate is expired or the cert's signature verification failed).
107 = Unacceptable TLS protocol version.
108 = App-defined server certificate requirements failure.
109 = Failed to read handshake messages.
110 = Failed to send client certificate handshake message.
111 = Failed to send client key exchange handshake message.
112 = Client certificate's private key not accessible.
113 = Failed to send client cert verify handshake message.
114 = Failed to send change cipher spec handshake message.
115 = Failed to send finished handshake message.
116 = Server's Finished message is invalid.
125 = Peer tried to connect using older SSL 2.0 protocol version.
126 = TLS Pin Set Mismatch.
127 = TLS 1.3 handshake error.

Connection

Declare.s ckConnection(obj.i)
Declare setCkConnection(obj.i, value.s)

The Connection header field to be automatically included with GET requests issued by QuickGet or QuickGetStr. The default value is "Keep-Alive". To prevent the Connection header from being added to the HTTP header, set this property to the empty string.

ConnectTimeout

Declare.i ckConnectTimeout(obj.i)
Declare setCkConnectTimeout(obj.i, value.i)

The amount of time in seconds to wait before timing out when connecting to an HTTP server. The default ConnectTimeout is 30 seconds.

Note: This is the maximum number of seconds to wait for a server to accept a TCP connection. Once the connection is accepted, and bytes begin flowing back-and-forth, then it is the ReadTimeout property that applies. It is the ReadTimeout that applies when receiving data, which includes the reads that occur during a TLS handshake.

CookieDir

Declare.s ckCookieDir(obj.i)
Declare setCkCookieDir(obj.i, value.s)

Specifies a directory where cookies are automatically persisted if the Http.SaveCookies property is turned on. Cookies are stored in XML formatted files, one per domain, to main it easy for other programs to understand and parse. May be set to the string "memory" to cache cookies in memory.

More Information and Examples

Caching cookies in-memory.

DebugLogFilePath

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

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:

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

More Information and Examples

Example showing how to use DebugLogFilePath.

DefaultFreshPeriod

Declare.i ckDefaultFreshPeriod(obj.i)
Declare setCkDefaultFreshPeriod(obj.i, value.i)

The default freshness period (in minutes) for cached documents when the FreshnessAlgorithm property is set to 0. The default value is 10080 (1 week).

DigestAuth

Declare.i ckDigestAuth(obj.i)
Declare setCkDigestAuth(obj.i, value.i)

Setting this property to 1 causes the HTTP component to use digest authentication. The default value is 0.

More Information and Examples

HTTP Authentication (Basic, NTLM, Digest, Negotiate)

FetchFromCache

Declare.i ckFetchFromCache(obj.i)
Declare setCkFetchFromCache(obj.i, value.i)

Set to true if pages should be fetched from cache when possible. Only HTTP GET requests are cached. HTTP responses that include Set-Cookie headers are not cached. A page is fetched from the disk cache if it is present and it is "fresh" according to the FreshnessAlgorithm property. If a page exists in cache but is not fresh, the HTTP component will issue a revalidate request and update the cache appropriately according to the response.

More Information and Examples

Fetch Web Pages from Local Cache

FinalRedirectUrl

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

If an HTTP GET was redirected (as indicated by the WasRedirected property), this property will contain the final redirect URL, assuming the FollowRedirects property is 1.

Note: Starting in v9.5.0.49, this property will contain the redirect URL for 301/302 responses even if FollowRedirects is not set to 1.

FollowRedirects

Declare.i ckFollowRedirects(obj.i)
Declare setCkFollowRedirects(obj.i, value.i)

If true, then 301, 302, 303, 307, and 308 redirects are automatically followed when calling QuickGet and QuickGetStr. FollowRedirects is true by default.

FreshnessAlgorithm

Declare.i ckFreshnessAlgorithm(obj.i)
Declare setCkFreshnessAlgorithm(obj.i, value.i)

The freshness algorithm to use when determining the freshness of a cached HTTP GET response. A value of 1 causes an LM-factor algorithm to be used. This is the default. The LMFactor property is a value between 1 and 100 indicating the percentage of time based on the last-modified date of the HTML page. For example, if the LMFactor is 50, and an HTML page was modified 10 days ago, then the page will expire (i.e. no longer be fresh) in 5 days (50% of 10 days). This only applies to HTTP responses that do not have page expiration information. If the FreshnessAlgorithm = 0, then a constant expire time period determined by the DefaultFreshPeriod property is used.

IgnoreMustRevalidate

Declare.i ckIgnoreMustRevalidate(obj.i)
Declare setCkIgnoreMustRevalidate(obj.i, value.i)

Some HTTP responses contain a "Cache-Control: must-revalidate" header. If this is present, the server is requesting that the client always issue a revalidate HTTP request instead of serving the page directly from cache. If IgnoreMustRevalidate is set to 1, then Chilkat HTTP will serve the page directly from cache without revalidating until the page is no longer fresh.

The default value of this property is 0.

IgnoreNoCache

Declare.i ckIgnoreNoCache(obj.i)
Declare setCkIgnoreNoCache(obj.i, value.i)

Some HTTP responses contain headers of various types that indicate that the page should not be cached. Chilkat HTTP will adhere to this unless this property is set to 1.

The default value of this property is 0.

KeepResponseBody

Declare.i ckKeepResponseBody(obj.i)
Declare setCkKeepResponseBody(obj.i, value.i)

Introduced in version 9.5.0.55

If 1, then the response body, if text, is saved to the LastResponseBody property for all methods that do not return an HttpResponse object. The default value of this property is 0.

More Information and Examples

S3 Delete Bucket

LastContentType

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

The content-type of the last HTTP response received by the HTTP component.

LastErrorHtml

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

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.

LastErrorText

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

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.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

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

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.

LastFromCache

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

Introduced in version 9.5.0.91

1 if the last GET was fetched from cache.

More Information and Examples

Fetch Web Pages from Local Cache

LastHeader

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

The text of the last HTTP header sent by any of this class's methods. The purpose of this property is to allow the developer to examine the exact HTTP header for debugging purposes.

LastMethodSuccess

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

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.

LastModDate

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

The value of the Last-Modified header in the last HTTP response received by the HTTP component.

LastResponseBody

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

Introduced in version 9.5.0.55

The response body of the last HTTP response received by the HTTP component (for methods that do not return an HttpResponse object). The last response body is only saved to this property IF the KeepResponseBody property is set to 1.

LastResponseHeader

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

The entire response header for the last HTTP response received by the HTTP component (for methods that do not return an HttpResponse object).

More Information and Examples

Get Response Header for Method that does not Return HttpResponse Object

LastStatus

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

The last HTTP status value received by the HTTP component. This only applies to methods that do not return an HTTP response object. For methods that return an HTTP response object, such as SynchronousRequest, the status code is found in the StatusCode property of the response object.

LastStatusText

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

Introduced in version 9.5.0.69

The last HTTP status text received by the HTTP component. This only applies to methods that do not return an HTTP response object. For methods that return an HTTP response object, such as SynchronousRequest, the status text is found in the StatusText property of the response object.

LMFactor

Declare.i ckLMFactor(obj.i)
Declare setCkLMFactor(obj.i, value.i)

An integer between 1 and 100 that indicates the percentage of time from the HTTP page's last-modified date that will be used for the freshness period. The default value is 25. For example, if a page is fetched with a last-modified date of 4 weeks ago, and the LMFactor = 25, then the page will be considered fresh in the cache for 1 week (25% of 4 weeks).

Login

Declare.s ckLogin(obj.i)
Declare setCkLogin(obj.i, value.s)

The HTTP login for pages requiring a login/password. Chilkat HTTP can do Basic, Digest, and NTLM HTTP authentication. (NTLM is also known as SPA (or Windows Integrated Authentication). To use Basic authentication, the BasicAuth property must be set equal to 1. It is not necessary to set the NtlmAuth or DigestAuth properties beforehand if NTLM or Digest authentication is needed. However, it is most efficient to pre-set these properties when the type of authentication is known in advance.

Important: If NTLM authentication is used, it may be incorrect to set the Login property equal to "mydomain\mylogin". Instead, set the LoginDomain property equal to "mydomain", and set this property equal to "mylogin".

Note: When the Login and Password properties are set, and the type of authentication is specified by setting one of the following properties equal to 1 (BasicAuth, DigestAuth, NtlmAuth), Chilkat will automatically add the "Authorization: ..." header in the correct format.

More Information and Examples

HTTP Authentication (Basic, NTLM, Digest, Negotiate)

LoginDomain

Declare.s ckLoginDomain(obj.i)
Declare setCkLoginDomain(obj.i, value.s)

The optional domain name to be used with NTLM / Negotiate authentication.

MaxConnections

Declare.i ckMaxConnections(obj.i)
Declare setCkMaxConnections(obj.i, value.i)

The maximum number of simultaneous open HTTP connections managed by the HTTP component. The Chilkat HTTP component automatically manages HTTP connections. If the number of open HTTP connections is about to be exceeded, the connection with the least recent activity is automatically closed.

MaxFreshPeriod

Declare.i ckMaxFreshPeriod(obj.i)
Declare setCkMaxFreshPeriod(obj.i, value.i)

Limits the amount of time a document can be kept "fresh" in the cache. The MaxFreshPeriod is specified in minutes, and the default value is 525600 which is equal to 1 year.

MaxResponseSize

Declare.i ckMaxResponseSize(obj.i)
Declare setCkMaxResponseSize(obj.i, value.i)

The maximum HTTP response size to be accepted by the calling program. A value of 0 (the default) indicates that there is no maximum value.

MaxUrlLen

Declare.i ckMaxUrlLen(obj.i)
Declare setCkMaxUrlLen(obj.i, value.i)

The Http class will automatically fail any URL longer than this length. The default MaxUrlLen is 2000 characters.

MimicFireFox

Declare.i ckMimicFireFox(obj.i)
Declare setCkMimicFireFox(obj.i, value.i)

If set to 1, then the appropriate headers to mimic Mozilla/FireFox are automatically added to requests sent via the QuickGet and QuickGetStr methods.

MimicIE

Declare.i ckMimicIE(obj.i)
Declare setCkMimicIE(obj.i, value.i)

If set to 1, then the appropriate headers to mimic Internet Explorer are automatically added to requests sent via the QuickGet and QuickGetStr methods.

MinFreshPeriod

Declare.i ckMinFreshPeriod(obj.i)
Declare setCkMinFreshPeriod(obj.i, value.i)

The freshness period for a document in cache will not be less than this value (in minutes). The default value is 30.

NegotiateAuth

Declare.i ckNegotiateAuth(obj.i)
Declare setCkNegotiateAuth(obj.i, value.i)

Set this property equal to 1 for Negotiate authentication.

Note: The NegotiateAuth property is only available for the Microsoft Windows operating system.

More Information and Examples

HTTP Authentication (Basic, NTLM, Digest, Negotiate)HTTPS Windows Integrated Authentication

NtlmAuth

Declare.i ckNtlmAuth(obj.i)
Declare setCkNtlmAuth(obj.i, value.i)

Setting this property to 1 causes the HTTP component to use NTLM authentication (also known as IWA -- or Integrated Windows Authentication) when authentication with an HTTP server. The default value is 0.

More Information and Examples

HTTP Authentication (Basic, NTLM, Digest, Negotiate)HTTPS Windows Integrated Authentication

NumCacheLevels

Declare.i ckNumCacheLevels(obj.i)
Declare setCkNumCacheLevels(obj.i, value.i)

The number of directory levels to be used under each cache root. The default is 0, meaning that each cached HTML page is stored in a cache root directory. A value of 1 causes each cached page to be stored in one of 255 subdirectories named "0","1", "2", ..."255" under a cache root. A value of 2 causes two levels of subdirectories ("0..255/0..255") under each cache root. The HTTP control automatically creates subdirectories as needed. The reason for mutliple levels is to alleviate problems that may arise with unrelated software when huge numbers of files are stored in a single directory. For example, Windows Explorer does not behave well when trying to display the contents of directories with thousands of files.

More Information and Examples

Fetch Web Pages from Local Cache

NumCacheRoots

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

The number of cache roots to be used for the HTTP cache. This allows the disk cache spread out over multiple disk drives. Each cache root is a string indicating the drive letter and directory path. For example, "E:\Cache". An example of a very large low-cost cache might be four USB external drives. To create a cache with four roots, call AddCacheRoot once for each directory root.

OAuth1

Declare.i ckOAuth1(obj.i)
Declare setCkOAuth1(obj.i, value.i)

If 1 then causes an OAuth Authorization header to be added to any request sent by the HTTP object. For example:

Authorization: OAuth realm="http://sp.example.com/",
                oauth_consumer_key="0685bd9184jfhq22",
                oauth_token="ad180jjd733klru7",
                oauth_signature_method="HMAC-SHA1",
                oauth_signature="wOJIO9A2W5mFwDgiDvZbTSMK%2FPY%3D",
                oauth_timestamp="137131200",
                oauth_nonce="4572616e48616d6d65724c61686176",
                oauth_version="1.0"

The information used to compute the OAuth Authorization header is obtained from the other OAuth* properties, such as OAuthConsumerKey, OAuthConsumerSecret, OAuthRealm, etc.

More Information and Examples

Mastercard ICCP Get Data Source with OAuth1 BrickLink OAuth1 using Chilkat HTTP

OAuthBodyHash

Declare.i ckOAuthBodyHash(obj.i)
Declare setCkOAuthBodyHash(obj.i, value.i)

Introduced in version 9.5.0.91

If set to 1, then the oauth_body_hash is automatically added to an OAuth1 Authorization header. The oauth_body_hash contains the SHA-256 hash of the HTTP request body that is sent.

OAuthCallback

Declare.s ckOAuthCallback(obj.i)
Declare setCkOAuthCallback(obj.i, value.s)

Introduced in version 9.5.0.53

The OAuth 1.0 callback URL. Defaults to "oob".

OAuthConsumerKey

Declare.s ckOAuthConsumerKey(obj.i)
Declare setCkOAuthConsumerKey(obj.i, value.s)

The OAuth consumer key to be used in the Authorization header.

OAuthConsumerSecret

Declare.s ckOAuthConsumerSecret(obj.i)
Declare setCkOAuthConsumerSecret(obj.i, value.s)

The OAuth consumer secret to be used in computing the contents of the Authorization header.

OAuthRealm

Declare.s ckOAuthRealm(obj.i)
Declare setCkOAuthRealm(obj.i, value.s)

The OAuth realm to be used in the Authorization header.

OAuthSigMethod

Declare.s ckOAuthSigMethod(obj.i)
Declare setCkOAuthSigMethod(obj.i, value.s)

The OAuth signature method, such as "HMAC-SHA1" to be used in the Authorization header. The default is "HMAC-SHA1". It is also possible to choose "HMAC-SHA256", "RSA-SHA1" or "RSA-SHA2". For RSA algorithms, an RSA private key would need to be provided via the SetOAuthRsaKey method.

Note: RSA-SHA2 is supported starting in Chilkat v9.5.0.56

OAuthToken

Declare.s ckOAuthToken(obj.i)
Declare setCkOAuthToken(obj.i, value.s)

The OAuth1 token to be used in the Authorization header. Note: This is for OAuth1. Use the AuthToken property for OAuth2.

More Information and Examples

Twitter OAuth -- Tweet to Your Own Account

OAuthTokenSecret

Declare.s ckOAuthTokenSecret(obj.i)
Declare setCkOAuthTokenSecret(obj.i, value.s)

The OAuth token secret to be used in computing the Authorization header.

OAuthVerifier

Declare.s ckOAuthVerifier(obj.i)
Declare setCkOAuthVerifier(obj.i, value.s)

The OAuth verifier to be used in the Authorization header.

Password

Declare.s ckPassword(obj.i)
Declare setCkPassword(obj.i, value.s)

The HTTP password for pages requiring a login/password. Chilkat HTTP can do Basic, Digest, and NTLM HTTP authentication. (NTLM is also known as SPA (or Windows Integrated Authentication). To use Basic authentication, the BasicAuth property must be set equal to 1. It is not necessary to set the NtlmAuth or DigestAuth properties beforehand if NTLM or Digest authentication is needed. However, it is most efficient to pre-set these properties when the type of authentication is known in advance.

Note: When the Login and Password properties are set, and the type of authentication is specified by setting one of the following properties equal to 1 (BasicAuth, DigestAuth, NtlmAuth), Chilkat will automatically add the "Authorization: ..." header in the correct format.

PreferIpv6

Declare.i ckPreferIpv6(obj.i)
Declare setCkPreferIpv6(obj.i, value.i)

If 1, then use IPv6 over IPv4 when both are supported for a particular domain. The default value of this property is 0, which will choose IPv4 over IPv6.

ProxyAuthMethod

Declare.s ckProxyAuthMethod(obj.i)
Declare setCkProxyAuthMethod(obj.i, value.s)

Set this to "basic" if you know in advance that Basic authentication is to be used for the HTTP proxy. Otherwise leave this property unset. Note: It is not necessary to set this property. The HTTP component will automatically handle proxy authentication for any of the supported authentication methods: NTLM, Digest, or Basic. Setting this property equal to "basic" prevents the 407 response which is automatically handled internal to Chilkat and never seen by your application.

Note: If NTLM authentication does not succeed, set the Global.DefaultNtlmVersion property equal to 1 and then retry.

ProxyDirectTls

Declare.i ckProxyDirectTls(obj.i)
Declare setCkProxyDirectTls(obj.i, value.i)

Introduced in version 9.5.0.83

Set to 1 if the proxy server expects a direct TLS connection. (This is where the initial connection to the HTTP proxy server is TLS. See Squid Direct TLS Connection. The default value of this property is 0.

More Information and Examples

HTTPS Requests over Squid Proxy Direct TLS Connection

ProxyDomain

Declare.s ckProxyDomain(obj.i)
Declare setCkProxyDomain(obj.i, value.s)

The domain name of a proxy host if an HTTP proxy is used. This can also be set to an IP address.

More Information and Examples

Using an HTTP Proxy for HTTP POST's, GET's, etc.

ProxyLogin

Declare.s ckProxyLogin(obj.i)
Declare setCkProxyLogin(obj.i, value.s)

If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy login.

ProxyLoginDomain

Declare.s ckProxyLoginDomain(obj.i)
Declare setCkProxyLoginDomain(obj.i, value.s)

The NTLM authentication domain (optional) if NTLM authentication is used.

ProxyPassword

Declare.s ckProxyPassword(obj.i)
Declare setCkProxyPassword(obj.i, value.s)

If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy password.

More Information and Examples

Using an HTTP Proxy for HTTP POST's, GET's, etc.

ProxyPort

Declare.i ckProxyPort(obj.i)
Declare setCkProxyPort(obj.i, value.i)

The port number of a proxy server if an HTTP proxy is used.

ReadTimeout

Declare.i ckReadTimeout(obj.i)
Declare setCkReadTimeout(obj.i, value.i)

The amount of time in seconds to wait before timing out when reading from an HTTP server. The ReadTimeout is the amount of time that needs to elapse while no additional data is forthcoming. During a long download, if the data stream halts for more than this amount, it will timeout. Otherwise, there is no limit on the length of time for the entire download.

The default value is 60 seconds. Note: Prior to v9.5.0.76, the default was 20 seconds.

ReceivedCertReq

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

Introduced in version 9.5.0.92

Indicates whether the last HTTPS connection received a TLS CertificateRequest handshake message indicating that the server may require a client certificate.

RedirectVerb

Declare.s ckRedirectVerb(obj.i)
Declare setCkRedirectVerb(obj.i, value.s)

Indicates the HTTP verb, such as GET, POST, PUT, etc. to be used for a redirect when the FollowRedirects property is set to 1. The default value of this property is "GET". This will produce the same behavior as a web browser (such as FireFox). If this property is set to the empty string, then it will cause the same verb as the original HTTP request to be used.

Note: Prior to version 9.5.0.44, the default value of this property was the empty string.

Referer

Declare.s ckReferer(obj.i)
Declare setCkReferer(obj.i, value.s)

The Referer header field to be automatically included with GET requests issued by QuickGet or QuickGetStr. The default value is the empty string which causes the Referer field to be omitted from the request header.

RequiredContentType

Declare.s ckRequiredContentType(obj.i)
Declare setCkRequiredContentType(obj.i, value.s)

If set, then any HTTP response to any POST or GET, including downloads, will be rejected if the content-type in the response header does not match this setting. If the content-type does not match, only the header of the HTTP response is read, the connection to the HTTP server is closed, and the remainder of the response is never read.

This property is empty (zero-length string) by default.

Some typical content-types are "text/html", "text/xml", "image/gif", "image/jpeg", "application/zip", "application/msword", "application/pdf", etc.

RequireSslCertVerify

Declare.i ckRequireSslCertVerify(obj.i)
Declare setCkRequireSslCertVerify(obj.i, value.i)

If 1, then the HTTP client will verify the server's SSL certificate. The certificate is expired, or if the cert's signature is invalid, the connection is not allowed. The default value of this property is 0.

More Information and Examples

Require that the Web Server's SSL Certificate is Non-Expired and the Signature is Valid

S3Ssl

Declare.i ckS3Ssl(obj.i)
Declare setCkS3Ssl(obj.i, value.i)

If 1, then all S3_* methods will use a secure SSL/TLS connection for communications. The default value is 1.

SaveCookies

Declare.i ckSaveCookies(obj.i)
Declare setCkSaveCookies(obj.i, value.i)

If this property is 1, cookies are automatically persisted to XML files in the directory specified by the CookiesDir property (or in memory if CookieDir = "memory"). Both CookiesDir and SaveCookies must be set for cookies to be persisted.

More Information and Examples

Caching cookies in-memory.

SendBufferSize

Declare.i ckSendBufferSize(obj.i)
Declare setCkSendBufferSize(obj.i, value.i)

The buffer size to be used with the underlying TCP/IP socket for sending. The default value is 65535.

SendCookies

Declare.i ckSendCookies(obj.i)
Declare setCkSendCookies(obj.i, value.i)

If 1, then cookies previously persisted to the CookiesDir are automatically added to all HTTP requests. Only cookies matching the domain and path are added.

More Information and Examples

Caching cookies in-memory.

SessionLogFilename

Declare.s ckSessionLogFilename(obj.i)
Declare setCkSessionLogFilename(obj.i, value.s)

Enables file-based session logging. If set to a filename (or relative/absolute filepath), then the exact HTTP requests and responses are logged to a file. The file is created if it does not already exist, otherwise it is appended.

More Information and Examples

Debugging HTTP HTTP Session Logging

SniHostname

Declare.s ckSniHostname(obj.i)
Declare setCkSniHostname(obj.i, value.s)

Introduced in version 9.5.0.82

Specifies the SNI hostname to be used in the TLS ClientHello. This property is only needed when the domain is specified via a dotted IP address and an SNI hostname is desired. (Normally, Chilkat automatically uses the domain name in the SNI hostname TLS ClientHello extension.)

SocksHostname

Declare.s ckSocksHostname(obj.i)
Declare setCkSocksHostname(obj.i, value.s)

The SOCKS4/SOCKS5 hostname or IPv4 address (in dotted decimal notation). This property is only used if the SocksVersion property is set to 4 or 5).

More Information and Examples

HTTP/HTTPS using SOCKS5 Proxy HTTP/HTTPS using SOCKS4 Proxy

SocksPassword

Declare.s ckSocksPassword(obj.i)
Declare setCkSocksPassword(obj.i, value.s)

The SOCKS5 password (if required). The SOCKS4 protocol does not include the use of a password, so this does not apply to SOCKS4.

SocksPort

Declare.i ckSocksPort(obj.i)
Declare setCkSocksPort(obj.i, value.i)

The SOCKS4/SOCKS5 proxy port. The default value is 1080. This property only applies if a SOCKS proxy is used (if the SocksVersion property is set to 4 or 5).

SocksUsername

Declare.s ckSocksUsername(obj.i)
Declare setCkSocksUsername(obj.i, value.s)

The SOCKS4/SOCKS5 proxy username. This property is only used if the SocksVersion property is set to 4 or 5).

More Information and Examples

HTTP/HTTPS using SOCKS5 Proxy HTTP/HTTPS using SOCKS4 Proxy

SocksVersion

Declare.i ckSocksVersion(obj.i)
Declare setCkSocksVersion(obj.i, value.i)

SocksVersion May be set to one of the following integer values:

0 - No SOCKS proxy is used. This is the default.
4 - Connect via a SOCKS4 proxy.
5 - Connect via a SOCKS5 proxy.

More Information and Examples

HTTP/HTTPS using SOCKS5 Proxy HTTP/HTTPS using SOCKS4 Proxy

SoRcvBuf

Declare.i ckSoRcvBuf(obj.i)
Declare setCkSoRcvBuf(obj.i, value.i)

Sets the receive buffer size socket option. Normally, this property should be left unchanged. The default value is 4194304.

This property can be increased if download performance seems slow. It is recommended to be a multiple of 4096.

More Information and Examples

More Information about TCP performance and Buffer Sizes

SoSndBuf

Declare.i ckSoSndBuf(obj.i)
Declare setCkSoSndBuf(obj.i, value.i)

Sets the send buffer size socket option. Normally, this property should be left unchanged. The default value is 262144.

This property can be increased if upload performance seems slow. It is recommended to be a multiple of 4096. Testing with sizes such as 512K and 1MB is reasonable.

More Information and Examples

More Information about TCP performance and Buffer Sizes

SslAllowedCiphers

Declare.s ckSslAllowedCiphers(obj.i)
Declare setCkSslAllowedCiphers(obj.i, value.s)

Introduced in version 9.5.0.48

Provides a means for setting a list of ciphers that are allowed for SSL/TLS connections. The default (empty string) indicates that all implemented ciphers are possible. The TLS ciphers supported in Chilkat v9.5.0.55 and later are:

TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256
TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
TLS_DHE_RSA_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_256_CBC_SHA256
TLS_RSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_RSA_WITH_AES_128_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDHE_RSA_WITH_RC4_128_SHA
TLS_RSA_WITH_RC4_128_SHA
TLS_RSA_WITH_RC4_128_MD5
TLS_DHE_RSA_WITH_DES_CBC_SHA
TLS_RSA_WITH_DES_CBC_SHA

To restrict SSL/TLS connections to one or more specific ciphers, set this property to a comma-separated list of ciphers such as "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384". The order should be in terms of preference, with the preferred algorithms listed first. (Note that the client cannot specifically choose the algorithm is picked because it is the server that chooses. The client simply provides the server with a list from which to choose.)

The property can also disallow connections with servers having certificates with RSA keys less than a certain size. By default, server certificates having RSA keys of 512 bits or greater are allowed. Add the keyword "rsa1024" to disallow connections with servers having keys smaller than 1024 bits. Add the keyword "rsa2048" to disallow connections with servers having keys smaller than 2048 bits.

Note: Prior to Chilkat v9.5.0.55, it was not possible to explicitly list allowed cipher suites. The deprecated means for indicating allowed ciphers was both incomplete and unprecise. For example, the following keywords could be listed to allow matching ciphers: "aes256-cbc", "aes128-cbc", "3des-cbc", and "rc4". These keywords will still be recognized, but programs should be updated to explicitly list the allowed ciphers.

secure-renegotiation: Starting in Chilkat v9.5.0.55, the keyword "secure-renegotiation" may be added to require that all renegotions be done securely (as per RFC 5746).

best-practices: Starting in Chilkat v9.5.0.55, this property may be set to the single keyword "best-practices". This will allow ciphers based on the current best practices. As new versions of Chilkat are released, the best practices may change. Changes will be noted here. The current best practices are:

If the server uses an RSA key, it must be 1024 bits or greater.
All renegotations must be secure renegotiations.
All ciphers using RC4, DES, or 3DES are disallowed.

Example: The following string would restrict to 2 specific cipher suites, require RSA keys to be 1024 bits or greater, and require secure renegotiations: "TLS_DHE_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, rsa1024, secure-renegotiation"

SslProtocol

Declare.s ckSslProtocol(obj.i)
Declare setCkSslProtocol(obj.i, value.s)

Introduced in version 9.5.0.46

Selects the SSL/TLS protocol version to be used for connections. Possible values are:

default
TLS 1.3
TLS 1.2
TLS 1.1
TLS 1.0
SSL 3.0
TLS 1.3 or higher
TLS 1.2 or higher
TLS 1.1 or higher
TLS 1.0 or higher

The default value is "default" which allows for the protocol to be selected dynamically at runtime based on the requirements of the server. Choosing an exact protocol will cause the connection to fail unless that exact protocol is negotiated. It is better to choose "X or higher" than an exact protocol. The "default" is effectively "SSL 3.0 or higher".

StreamResponseBodyPath

Declare.s ckStreamResponseBodyPath(obj.i)
Declare setCkStreamResponseBodyPath(obj.i, value.s)

Introduced in version 9.5.0.49

Allows for the HTTP response body to be streamed directly into a file. If this property is set, then any method returning an HTTP response object will stream the response body directly to the file path specified. The HTTP response object will still contain the response header. (This property is useful when the HTTP response is too large to fit into memory.)

TlsCipherSuite

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

Introduced in version 9.5.0.49

Contains the current or last negotiated TLS cipher suite. If no TLS connection has yet to be established, or if a connection as attempted and failed, then this will be empty. A sample cipher suite string looks like this: TLS_DHE_RSA_WITH_AES_256_CBC_SHA256.

TlsPinSet

Declare.s ckTlsPinSet(obj.i)
Declare setCkTlsPinSet(obj.i, value.s)

Introduced in version 9.5.0.55

Specifies a set of pins for Public Key Pinning for TLS connections. This property lists the expected SPKI fingerprints for the server certificates. If the server's certificate (sent during the TLS handshake) does not match any of the SPKI fingerprints, then the TLS handshake is aborted and the connection fails. The format of this string property is as follows:

hash_algorithm, encoding, SPKI_fingerprint_1, SPKI_fingerprint_2, ...

For example, the following string specifies a single sha256 base64-encoded SPKI fingerprint:

"sha256, base64, lKg1SIqyhPSK19tlPbjl8s02yChsVTDklQpkMCHvsTE="

This example specifies two SPKI fingerprints:

"sha256, base64, 4t37LpnGmrMEAG8HEz9yIrnvJV2euVRwCLb9EH5WZyI=, 68b0G5iqMvWVWvUCjMuhLEyekM5729PadtnU5tdXZKs="

Any of the following hash algorithms are allowed:.sha1, sha256, sha384, sha512, md2, md5, haval, ripemd128, ripemd160,ripemd256, or ripemd320.

The following encodings are allowed: base64, hex, and any of the encodings indicated in the link below.

More Information and Examples

Encodings Supported by Chilkat HTTP Public Key Pinning

TlsVersion

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

Introduced in version 9.5.0.49

Contains the current or last negotiated TLS protocol version. If no TLS connection has yet to be established, or if a connection as attempted and failed, then this will be empty. Possible values are "SSL 3.0", "TLS 1.0", "TLS 1.1", "TLS 1.2", and "TLS 1.3".

UncommonOptions

Declare.s ckUncommonOptions(obj.i)
Declare setCkUncommonOptions(obj.i, value.s)

This is a catch-all property to be used for uncommon needs. This property defaults to the empty string and should typically remain empty. Can be set to a list of the following comma separated keywords:

"QuickDisconnect" - Introduced in v9.5.0.77. In the call to CloseAllConnections, do not disconnect cleanly. Instead just disconnect as quickly as possible.
"ProtectFromVpn" - Introduced in v9.5.0.80. On Android systems, will bypass any VPN that may be installed or active.
"TlsNoClientRootCert" - Introduced in v9.5.0.82. Will exclude root CA certs from being included in the client certificate chain that is sent to the server for client-side authentication. This must be set prior to calling SetSslClientCert.
"AllowEmptyHeaders" - Introduced in v9.5.0.82. If present, an empty value string passed to SetHeaderField will cause the header to be added with an empty value. Otherwise, for historical purposes and backward compatibility, the header field is removed when an empty value string is passed.
"AnsiLogin" - Introduced in v9.5.0.87. For HTTP basic authentication, the login and password is sent using the utf-8 byte representation. Some servers expect the ANSI byte representation (typically Windows-1252). Use this keyword to send the login/password using ANSI.

UpdateCache

Declare.i ckUpdateCache(obj.i)
Declare setCkUpdateCache(obj.i, value.i)

Controls whether the cache is automatically updated with the responses from HTTP GET requests.

More Information and Examples

Fetch Web Pages from Local Cache

UseIEProxy

Declare.i ckUseIEProxy(obj.i)
Declare setCkUseIEProxy(obj.i, value.i)

If 1, the proxy address/port used by Internet Explorer will also be used by Chilkat HTTP. Note: This property only pays attention to the proxy address and port, and does not pay attention to additional information such as IE proxy server exceptions.

UserAgent

Declare.s ckUserAgent(obj.i)
Declare setCkUserAgent(obj.i, value.s)

This property, if set, is the value of the User-Agent header field to be automatically included with GET requests issued by QuickGet or QuickGetStr. The default value is the empty string and no User-Agent header field will be sent.

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 "9.5.0.94"

More Information and Examples

How to get the Chilkat version at runtime.

WasRedirected

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

Indicates whether the last HTTP request was redirected (i.e. the redirect was automatically followed). If FollowRedirects is 0 and the response status code is 301, 302, 303, 307, or 308, then this property will remain 0 but the FinalRedirectUrl will contain the redirect URL that was not automatically followed.

Methods

AddCacheRoot

Declare ckAddCacheRoot(obj.i, dir.s)

This method must be called at least once if disk caching is to be used. The file path (including drive letter) such as "E:\MyHttpCache\" is passed to AddCacheRoot to specify the root directory. The cache can be spread across multiple disk drives by calling AddCacheRoot multiple times, each with a directory path on a separate disk drive.

More Information and Examples

Fetch Web Pages from Local Cache

ClearHeaders

Declare ckClearHeaders(obj.i)

Introduced in version 9.5.0.77

Removes all headers added via the SetRequestHeader method.

ClearInMemoryCookies

Declare ckClearInMemoryCookies(obj.i)

Clears all cookies cached in memory. Calling this only makes sense if the CookieDir property is set to the string "memory".

ClearUrlVars

Declare ckClearUrlVars(obj.i)

Introduced in version 9.5.0.67

Clears all URL variable values previously set by one or more calls to SetUrlVar.

CloseAllConnections

Declare.i ckCloseAllConnections(obj.i)

Closes all connections still open from previous HTTP requests.

An HTTP object instance will maintain up to 10 connections. If the HTTP server's response does not include a "Connection: Close" header, the connection will remain open and will be re-used if possible for the next HTTP request to the same hostname:port. (It uses the IP address (in string form) or the domain name, whichever is used in the URL provided by the application.) If 10 connections are already open and another is needed, the object will close the least recently used connection.

Returns 1 for success, 0 for failure.

CloseAllConnectionsAsync ⁽¹⁾

Declare.i ckCloseAllConnectionsAsync(obj.i)

Creates an asynchronous task to call the CloseAllConnections method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

CreateOcspRequest

Declare.i ckCreateOcspRequest(obj.i, requestDetails.i, ocspRequest.i)

Introduced in version 9.5.0.75

Creates an OCSP request for one or more certificates. The requestDetails is a JSON document describing the content of the OCSP request to be created. The examples in the links below show how to build the JSON request details.

Note: This method only creates an OCSP request. After creating, it may be sent to a server to get the OCSP response.

Returns 1 for success, 0 for failure.

More Information and Examples

Validate Certificate using OCSP Protocol

CreateTimestampRequest

Declare.i ckCreateTimestampRequest(obj.i, hashAlg.s, hashVal.s, reqPolicyOid.s, addNonce.l, reqTsaCert.l, timestampToken.i)

Introduced in version 9.5.0.75

Creates an RFC 3161 time-stamp request and returns the binary request token in timestampToken. The hashAlg can be "sha1", "sha256", "sha384", "sha512", or "md5", The hashVal is the base64 hash of the data to be timestamped. The optional reqPolicyOid is the requested policy OID in a format such as "1.3.6.1.4.1.47272.1.2". The addNonce indicates whether to auto-generate and include a nonce in the request. It may be 1 or 0. The reqTsaCert determines whether or not to request the TSA's certificate (1 = Yes, 0 = No).

Note: This method only creates a timestamp request. After creating, it may be sent to a server to get the binary timestamp token.

Returns 1 for success, 0 for failure.

More Information and Examples

RFC3161 Timestamp Client - Fetch from Timestamp Authority (TSA) and Verify Combine Timestamp Reply and Content File into a TimeStampData

DnsCacheClear

Declare ckDnsCacheClear(obj.i)

Introduced in version 9.5.0.38

Clears the Chilkat-wide in-memory hostname-to-IP address DNS cache. Chilkat automatically maintains this in-memory cache to prevent redundant DNS lookups. If the TTL on the DNS A records being accessed are short and/or these DNS records change frequently, then this method can be called clear the internal cache. Note: The DNS cache is used/shared among all Chilkat objects in a program, and clearing the cache affects all Chilkat objects.

Download

Declare.i ckDownload(obj.i, url.s, localFilePath.s)

Retrieves the content at a URL and saves to a file. All content is saved in streaming mode such that the memory footprint is small and steady. HTTPS is fully supported, as it is with all the methods of this class.

Returns 1 for success, 0 for failure.

More Information and Examples

HTTP Downloads Explained HTTP Download any Type of File (binary or text)Debugging HTTP HTTP Download in Parallel with Simultaneous Range Requests

DownloadAsync ⁽¹⁾

Declare.i ckDownloadAsync(obj.i, url.s, localFilePath.s)

Creates an asynchronous task to call the Download method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

DownloadAppend

Declare.i ckDownloadAppend(obj.i, url.s, filename.s)

Same as the Download method, but the output file is open for append.

Returns 1 for success, 0 for failure.

More Information and Examples

HTTP Downloads Explained

DownloadAppendAsync ⁽¹⁾

Declare.i ckDownloadAppendAsync(obj.i, url.s, filename.s)

Creates an asynchronous task to call the DownloadAppend method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

DownloadBd

Declare.i ckDownloadBd(obj.i, url.s, binData.i)

Introduced in version 9.5.0.63

Downloads the content at the url into a BinData object.

Returns 1 for success, 0 for failure.

More Information and Examples

HTTP Downloads Explained Upload In-Memory Binary Data to Google Cloud Storage Box.com Download Binary File to Memory Download Image (JPG, GIF, etc.) to Base64

DownloadBdAsync ⁽¹⁾

Declare.i ckDownloadBdAsync(obj.i, url.s, binData.i)

Introduced in version 9.5.0.63

Creates an asynchronous task to call the DownloadBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

DownloadHash

Declare.s ckDownloadHash(obj.i, url.s, hashAlgorithm.s, encoding.s)

Retrieves the content at a URL and computes and returns a hash of the content. The hash is returned as an encoded string according to the encoding, which may be "Base64", "modBase64", "Base32", "UU", "QP" (for quoted-printable), "URL" (for url-encoding), "Hex", "Q", "B", "url_oath", "url_rfc1738", "url_rfc2396", and "url_rfc3986". The hashAlgorithm may be "sha1", "sha256", "sha384", "sha512", "md2", "md5", "haval", "ripemd128", "ripemd160","ripemd256", or "ripemd320".

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

More Information and Examples

HTTP Downloads Explained

DownloadHashAsync ⁽¹⁾

Declare.i ckDownloadHashAsync(obj.i, url.s, hashAlgorithm.s, encoding.s)

Creates an asynchronous task to call the DownloadHash method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

DownloadSb

Declare.i ckDownloadSb(obj.i, url.s, charset.s, sb.i)

Introduced in version 9.5.0.63

Downloads the content at the url into a Chilkat StringBuilder object. The charset tells Chilkat how to interpret the bytes received. The sb is appended with the downloaded text data.

Returns 1 for success, 0 for failure.

More Information and Examples

HTTP Downloads Explained

DownloadSbAsync ⁽¹⁾

Declare.i ckDownloadSbAsync(obj.i, url.s, charset.s, sb.i)

Introduced in version 9.5.0.63

Creates an asynchronous task to call the DownloadSb method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

ExtractMetaRefreshUrl

Declare.s ckExtractMetaRefreshUrl(obj.i, htmlContent.s)

Convenience method for extracting the META refresh URL from HTML. For example, if the htmlContent contains a META refresh tag, such as:

<meta http-equiv="refresh" content="5;URL='http://example.com/'">

Then the return value of this method would be "http://example.com/".

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

G_SvcOauthAccessToken

Declare.s ckG_SvcOauthAccessToken(obj.i, iss.s, scope.s, subEmail.s, numSec.l, cert.i)

Introduced in version 9.5.0.44

Makes an access token request to obtain a Google API OAuth2 access token for a service account. Access tokens issued by the Google OAuth 2.0 Authorization Server expire one hour after they are issued. When an access token expires, then the application should generate another JWT, sign it, and request another access token. The iss is the service account email address of the application making the access token request. The scope is a space-delimited list of the permissions that the application requests. (See https://developers.google.com/accounts/docs/OAuth2ServiceAccount )

The subEmail is the email address of the user for which the application is requesting delegated access. The subEmail may be left empty if there is no such email address.

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

More Information and Examples

Get XOAUTH2 Access Token from Google OAuth 2.0 Authorization Server

G_SvcOauthAccessTokenAsync ⁽¹⁾

Declare.i ckG_SvcOauthAccessTokenAsync(obj.i, iss.s, scope.s, subEmail.s, numSec.l, cert.i)

Introduced in version 9.5.0.44

Creates an asynchronous task to call the G_SvcOauthAccessToken method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

G_SvcOauthAccessToken2

Declare.s ckG_SvcOauthAccessToken2(obj.i, claimParams.i, numSec.l, cert.i)

Introduced in version 9.5.0.51

The same as the G_SvcOauthAccessToken method, but with added flexibility for more customization. The 1st three args of the G_SvcOauthAccessToken are replaced with claimParams allowing for future expansion of name-value params. See the example below.

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

More Information and Examples

Get OAuth 2.0 Access Token using G_SvcOauthAccessToken2

G_SvcOauthAccessToken2Async ⁽¹⁾

Declare.i ckG_SvcOauthAccessToken2Async(obj.i, claimParams.i, numSec.l, cert.i)

Introduced in version 9.5.0.51

Creates an asynchronous task to call the G_SvcOauthAccessToken2 method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

GenTimeStamp

Declare.s ckGenTimeStamp(obj.i)

Returns the current GMT (also known as UTC) date/time in a string that is compliant with RFC 2616 format.

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

GetCacheRoot

Declare.s ckGetCacheRoot(obj.i, index.l)

Returns the Nth cache root (indexing begins at 0). Cache roots are set by calling AddCacheRoot one or more times.

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

GetCookieXml

Declare.s ckGetCookieXml(obj.i, domain.s)

Returns the cookies in XML format for a specific domain. Cookies are only persisted if the SaveCookies property is set to 1. If the CookieDir property is set to the keyword "memory", then cookies are saved in-memory.

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

More Information and Examples

Demonstrates how to Get Cookies Sent by the HTTP Server

GetDomain

Declare.s ckGetDomain(obj.i, url.s)

Utility method for extracting the domain name from a full URL. For example, if "https://www.chilkatsoft.com/default.asp" is the URL passed in, then "www.chilkatsoft.com" is returned.

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

GetHead

Declare.i ckGetHead(obj.i, url.s)

Sends an HTTP HEAD request for a URL and returns a response object. (Note: HEAD requests will never automatically follow redirects.)

Returns 0 on failure

More Information and Examples

HTTP HEAD Request Get the Last-Modified Date Before HTTP Download Get Size of File on Web Server

GetHeadAsync ^{(1) (2)}

Declare.i ckGetHeadAsync(obj.i, url.s)

Creates an asynchronous task to call the GetHead method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

GetRequestHeader

Declare.s ckGetRequestHeader(obj.i, name.s)

Returns the value of a header field that has been pre-defined to be sent with all HTTP GET requests issued by the QuickGet and QuickGetStr methods. By default, this includes header fields such as Accept, AcceptCharset, AcceptLanguage, Connection, UserAgent, etc.

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

GetServerSslCert

Declare.i ckGetServerSslCert(obj.i, domain.s, port.l)

Establishes an SSL/TLS connection with a web server for the purpose of retrieving the server's SSL certificate (public-key only of course...). Nothing is retrieved from the web server. This method simply makes a connection, gets the certificate information, and closes the connection.

Returns 0 on failure

More Information and Examples

Get the Server Certificate, Certificate Chain, and Root CA Certificate Get Web Server's SPKI Fingerprint

GetServerSslCertAsync ^{(1) (2)}

Declare.i ckGetServerSslCertAsync(obj.i, domain.s, port.l)

Creates an asynchronous task to call the GetServerSslCert method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

GetUrlPath

Declare.s ckGetUrlPath(obj.i, url.s)

Returns the path part of a URL. The syntax of a URL is <scheme>://<user>:<password>@<host>:<port>/<path>;<params>?<query>#<frag>. This method returns the "path" part.

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

HasRequestHeader

Declare.i ckHasRequestHeader(obj.i, name.s)

Returns true if the specified header field is defined such that it will be sent with all GET requests issued by the QuickGet and QuickGetStr methods.

LastJsonData

Declare.i ckLastJsonData(obj.i)

Introduced in version 9.5.0.79

Provides information about what transpired in the last method called on this object instance. For many methods, there is no information. However, for some methods, details about what occurred can be obtained by getting the LastJsonData right after the method call returns.

Returns 0 on failure

LoadTaskCaller

Declare.i ckLoadTaskCaller(obj.i, task.i)

Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns 1 for success, 0 for failure.

OcspCheck

Declare.i ckOcspCheck(obj.i, domain.s, port.l)

Introduced in version 9.5.0.84

Gets the server certificate at a domain:port and then sends an OCSP request to the certificate's OCSP URL to determine if the certificate has been revoked. Returns the OCSP status, which has one of the following values:

-1: Unable to check. See the contents of the LastErrorText property for more informaiton.
0: Good
1: Revoked
2: Unknown

More Information and Examples

OCSP Check Domain's Server Certificate Revocation Status

OcspCheckAsync ⁽¹⁾

Declare.i ckOcspCheckAsync(obj.i, domain.s, port.l)

Introduced in version 9.5.0.84

Creates an asynchronous task to call the OcspCheck method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

ParseOcspReply

Declare.i ckParseOcspReply(obj.i, ocspReply.i, replyData.i)

Introduced in version 9.5.0.75

Parses an OCSP reply. Returns the following possible integer values:

-1: The ocspReply does not contain a valid OCSP reply.
0: Successful - Response has valid confirmations..
1: Malformed request - Illegal confirmation request.
2: Internal error - Internal error in issuer.
3: Try later - Try again later.
4: Not used - This value is never returned.
5: Sig required - Must sign the request.
6: Unauthorized - Request unauthorized.

The binaryOCSP reply is provided in ocspReply. The replyData is populated with data parsed from ocspReply.

More Information and Examples

Validate Certificate using OCSP Protocol

PBinaryBd

Declare.i ckPBinaryBd(obj.i, verb.s, url.s, argData.i, contentType.s, md5.l, gzip.l)

Introduced in version 9.5.0.69

The same as PBinary, but the data to be uploaded is passed in data.

Returns 0 on failure

More Information and Examples

Upload In-Memory Binary Data to Google Cloud Storage

PBinaryBdAsync ^{(1) (2)}

Declare.i ckPBinaryBdAsync(obj.i, verb.s, url.s, argData.i, contentType.s, md5.l, gzip.l)

Introduced in version 9.5.0.69

Creates an asynchronous task to call the PBinaryBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

PFile

Declare.i ckPFile(obj.i, verb.s, url.s, localFilePath.s, contentType.s, md5.l, gzip.l)

Introduced in version 9.5.0.83

Sends an HTTP/HTTPS request to the url. The verb can be "POST", "PUT", "PATCH", etc. The url can begin with "http://" or "https://" depending if TLS is desired. The body of the HTTP request is streamed directly from the localFilePath. The contentType is a content type such as "image/gif", "application/pdf", "text/xml", etc. If md5 is 1, then a Content-MD5 header is added with the base64 MD5 hash of the localFilePath. Servers aware of the Content-MD5 header will perform a message integrity check to ensure that the data has not been corrupted. If gzip is 1, the localFilePath is compressed using the gzip algorithm. The HTTP request body will contain the GZIP compressed data, and a "Content-Encoding: gzip" header is automatically added to indicate that the request data needs to be ungzipped when received (at the server).

Returns 0 on failure

More Information and Examples

Create S3 Pre-Signed URL for Upload S3 Upload with Transfer Acceleration

PFileAsync ^{(1) (2)}

Declare.i ckPFileAsync(obj.i, verb.s, url.s, localFilePath.s, contentType.s, md5.l, gzip.l)

Introduced in version 9.5.0.83

Creates an asynchronous task to call the PFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

PostJson

Declare.i ckPostJson(obj.i, url.s, jsonText.s)

A simplified way of sending a JSON POST and receiving the JSON response. The HTTP response is returned in an HTTP response object. The content type of the HTTP request is "application/json". To send a JSON POST using a different content-type, call the PostJson2 method where the content type can be explicitly specified.

Returns 0 on failure

More Information and Examples

HTTP Tutorial - Common HTTP Requests Explained HTTP POST JSON

PostJsonAsync ^{(1) (2)}

Declare.i ckPostJsonAsync(obj.i, url.s, jsonText.s)

Creates an asynchronous task to call the PostJson method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

PostJson2

Declare.i ckPostJson2(obj.i, url.s, contentType.s, jsonText.s)

The same as PostJson,except it allows for the content type to be explicitly provided. The PostJson method automatically uses "application/jsonrequest". If the application needs for the content type to be "application/json", or some other content type, then PostJson2 provides the means.

Returns 0 on failure

More Information and Examples

HTTP POST JSON (application/json)HttpPostJson2 Example HttpPostJson2Async Example

PostJson2Async ^{(1) (2)}

Declare.i ckPostJson2Async(obj.i, url.s, contentType.s, jsonText.s)

Creates an asynchronous task to call the PostJson2 method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

PostJson3

Declare.i ckPostJson3(obj.i, url.s, contentType.s, json.i)

Introduced in version 9.5.0.68

The same as PostJson2,except a JSON object is passed in for the request body.

Returns 0 on failure

More Information and Examples

Auth0 Server-to-Server Access Token (Client Credentials flow)

PostJson3Async ^{(1) (2)}

Declare.i ckPostJson3Async(obj.i, url.s, contentType.s, json.i)

Introduced in version 9.5.0.68

Creates an asynchronous task to call the PostJson3 method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

PostUrlEncoded

Declare.i ckPostUrlEncoded(obj.i, url.s, req.i)

Sends a simple URL encoded POST. The form parameters are sent in the body of the HTTP request in x-www-form-urlencoded format. The content-type is "application/x-www-form-urlencoded".

Returns 0 on failure

More Information and Examples

HTTP Tutorial - Common HTTP Requests Explained Duplicating a Simple HTML Form Submission (POST)HTTP POST x-www-form-urlencoded Debugging HTTP PostUrlEncoded Clarified PostXml vs. PostUrlEncoded URL Encoding Charset in POST Query Params

PostUrlEncodedAsync ^{(1) (2)}

Declare.i ckPostUrlEncodedAsync(obj.i, url.s, req.i)

Creates an asynchronous task to call the PostUrlEncoded method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

PostXml

Declare.i ckPostXml(obj.i, endpointUrl.s, xmlContent.s, xmlCharset.s)

A simplified way of posting XML content to a web server. This method is good for making SOAP calls using HTTP POST. The xmlCharset should match the character encoding used in the xmlContent, which is typically "utf-8". The HTTP response is returned in an HTTP response object.

Important: This method sends the POST with a "Content-Type" header value of "application/xml". In rare cases, a server might require the Content-Type header to be "text/xml". To use "text/xml" instead of the default "application/xml", call SetRequestHeader("Content-Type","text/xml") prior to calling this method.

To use HTTPS simply pass an endpointUrl beginning with "https://" instead of "http://". This applies to any Chilkat method where a URL is passed as an argument.

Returns 0 on failure

More Information and Examples

HTTP Tutorial - Common HTTP Requests Explained Send XMLHttpRequest and Get Response Calling a SOAP Web Service using PostXml Debugging HTTP Send SOAP 1.2 Request to Web Service Requiring Authentication PostXml vs. PostUrlEncoded

PostXmlAsync ^{(1) (2)}

Declare.i ckPostXmlAsync(obj.i, endpointUrl.s, xmlContent.s, xmlCharset.s)

Creates an asynchronous task to call the PostXml method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

PText

Declare.i ckPText(obj.i, verb.s, url.s, textData.s, charset.s, contentType.s, md5.l, gzip.l)

Introduced in version 9.5.0.46

Sends an HTTP request to the url. The verb can be "POST", "PUT", "PATCH", etc. The body of the HTTP request contains the text passed in textData. The contentType is a content type such as "text/xml", "application/json", etc. If md5 is 1, then a Content-MD5 header is added with the base64 MD5 hash of the textData. Servers aware of the Content-MD5 header will perform a message integrity check to ensure that the data has not been corrupted. If gzip is 1, the contentType is compressed using the gzip algorithm. The HTTP request body will contain the GZIP compressed data, and a "Content-Encoding: gzip" header is automatically added to indicate that the request data needs to be ungzipped when received (at the server).

Returns 0 on failure

More Information and Examples

Outlook Contacts Update (PATCH) a Contact

PTextAsync ^{(1) (2)}

Declare.i ckPTextAsync(obj.i, verb.s, url.s, textData.s, charset.s, contentType.s, md5.l, gzip.l)

Introduced in version 9.5.0.46

Creates an asynchronous task to call the PText method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

PTextSb

Declare.i ckPTextSb(obj.i, verb.s, url.s, textData.i, charset.s, contentType.s, md5.l, gzip.l)

Introduced in version 9.5.0.69

The same as PText, but the data to be uploaded is passed in textData.

Returns 0 on failure

More Information and Examples

Upload String to Google Cloud Storage Send GMail with Attachments

PTextSbAsync ^{(1) (2)}

Declare.i ckPTextSbAsync(obj.i, verb.s, url.s, textData.i, charset.s, contentType.s, md5.l, gzip.l)

Introduced in version 9.5.0.69

Creates an asynchronous task to call the PTextSb method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

PutText

Declare.s ckPutText(obj.i, url.s, textData.s, charset.s, contentType.s, md5.l, gzip.l)

Sends an HTTP PUT request to the url. The body of the HTTP request is textData. The charset should be set to a charset name such as "iso-8859-1", "windows-1252", "Shift_JIS", "utf-8", etc. The string "ansi" may also be used as a charset name. The contentType is a content type such as "text/plain", "text/xml", etc. If md5 is 1, then a Content-MD5 header is added with the base64 MD5 hash of the textData. Servers aware of the Content-MD5 header will perform a message integrity check to ensure that the data has not been corrupted. If gzip is 1, the textData is compressed using the gzip algorithm. The HTTP request body will contain the GZIP compressed data, and a "Content-Encoding: gzip" header is automatically added to indicate that the request data needs to be ungzipped when received (at the server).

Returns the text body of the HTTP response if the HTTP response has a success status code. Otherwise the method is considered to have failed. If more details of the HTTP response are required, call PText instead (which returns the HTTP response object).

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

More Information and Examples

PutTextAsync ⁽¹⁾

Declare.i ckPutTextAsync(obj.i, url.s, textData.s, charset.s, contentType.s, md5.l, gzip.l)

Creates an asynchronous task to call the PutText method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

QuickDeleteStr

Declare.s ckQuickDeleteStr(obj.i, url.s)

Same as QuickGetStr, but uses the HTTP DELETE method instead of the GET method.

Note: The HTTP response code is available in the LastStatus property. Other properties having information include LastResponseHeader, LastResponseBody, LastModDate, LastContentType, etc.

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

More Information and Examples

QuickDeleteStr Example Debugging HTTP

QuickDeleteStrAsync ⁽¹⁾

Declare.i ckQuickDeleteStrAsync(obj.i, url.s)

Creates an asynchronous task to call the QuickDeleteStr method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

QuickGetBd

Declare.i ckQuickGetBd(obj.i, url.s, binData.i)

Introduced in version 9.5.0.64

The same as QuickGet, but returns the content in a Chilkat BinData object. The existing content of binData, if any, is cleared and replaced with the downloaded content.

A response code >= 400 is considered a failure and the method will return 0. However, the error response will still be returned in binData. If the error response was textual in nature, then it will also be available in the LastResponseBody property.

Returns 1 for success, 0 for failure.

More Information and Examples

QuickGetBd Example Create Enveloping XML Digital Signature

QuickGetBdAsync ⁽¹⁾

Declare.i ckQuickGetBdAsync(obj.i, url.s, binData.i)

Introduced in version 9.5.0.64

Creates an asynchronous task to call the QuickGetBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

QuickGetObj

Declare.i ckQuickGetObj(obj.i, url.s)

Sends an HTTP GET request for a URL and returns the response object. If the SendCookies property is 1, matching cookies previously persisted to the CookiesDir are automatically included in the request. If the FetchFromCache property is 1, the page could be fetched directly from cache.

Returns 0 on failure

More Information and Examples

QuickGetObj Example Getting the HTTP Response after an Asynchronous HTTP Request Completes

QuickGetObjAsync ^{(1) (2)}

Declare.i ckQuickGetObjAsync(obj.i, url.s)

Creates an asynchronous task to call the QuickGetObj method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

QuickGetSb

Declare.i ckQuickGetSb(obj.i, url.s, sbContent.i)

Introduced in version 9.5.0.64

The same as QuickGetStr, but returns the content in a Chilkat StringBuilder object. The existing content of sbContent, if any, is cleared and replaced with the downloaded content.

If the response status code is >= 400, then this method returns 0, but the body of the HTTP response is still returned in sbContent. This allows for the application to examine the response body for cases where an error is returned, but the expected content is not received.

Returns 1 for success, 0 for failure.

More Information and Examples

Load XML from a Remote URL

QuickGetSbAsync ⁽¹⁾

Declare.i ckQuickGetSbAsync(obj.i, url.s, sbContent.i)

Introduced in version 9.5.0.64

Creates an asynchronous task to call the QuickGetSb method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

QuickGetStr

Declare.s ckQuickGetStr(obj.i, url.s)

Sends an HTTP GET request for a URL and returns the response body as a string. The URL may contain query parameters. If the SendCookies property is 1, matching cookies previously persisted to the CookiesDir are automatically included in the request. If the FetchFromCache property is 1, the page could be fetched directly from cache. If the HTTP request fails, a 0 value is returned and error information can be found in the LastErrorText, LastErrorXml, or LastErrorHtml properties.

Note: The HTTP response code is available in the LastStatus property. Other properties having information include LastResponseHeader, LastResponseBody, LastModDate, LastContentType, etc.

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

More Information and Examples

HTTP GET - Download HTML or any Text Content to a String HTTPS GET using SSL/TLS HTTPS GET URL with URL Encoded Query Params

QuickGetStrAsync ⁽¹⁾

Declare.i ckQuickGetStrAsync(obj.i, url.s)

Creates an asynchronous task to call the QuickGetStr method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

QuickPutStr

Declare.s ckQuickPutStr(obj.i, url.s)

Same as QuickGetStr, but uses the HTTP PUT method instead of the GET method.

Note: The HTTP response code is available in the LastStatus property. Other properties having information include LastResponseHeader, LastResponseBody, LastModDate, LastContentType, etc.

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

More Information and Examples

QuickPutStrAsync ⁽¹⁾

Declare.i ckQuickPutStrAsync(obj.i, url.s)

Creates an asynchronous task to call the QuickPutStr method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

QuickRequest

Declare.i ckQuickRequest(obj.i, verb.s, url.s)

Introduced in version 9.5.0.77

Sends an HTTP request with no body for a URL and returns the response object. The verb is typically "GET" or "DELETE".

If the SendCookies property is 1, matching cookies previously persisted to the CookiesDir are automatically included in the request. If the FetchFromCache property is 1, the page could be fetched directly from cache.

Returns 0 on failure

More Information and Examples

QuickRequest Method - GET and DELETE

QuickRequestAsync ^{(1) (2)}

Declare.i ckQuickRequestAsync(obj.i, verb.s, url.s)

Introduced in version 9.5.0.77

Creates an asynchronous task to call the QuickRequest method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

QuickRequestParams

Declare.i ckQuickRequestParams(obj.i, verb.s, url.s, json.i)

Introduced in version 9.5.0.89

This is the same as the QuickRequest method, except query params can be provided as non-URL-encoded name/value members in the json.

Returns 0 on failure

More Information and Examples

Demonstrates the Http.QuickRequestParams Method QR Code Generator via api.qrserver.com REST API

QuickRequestParamsAsync ^{(1) (2)}

Declare.i ckQuickRequestParamsAsync(obj.i, verb.s, url.s, json.i)

Introduced in version 9.5.0.89

Creates an asynchronous task to call the QuickRequestParams method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

RemoveRequestHeader

Declare ckRemoveRequestHeader(obj.i, name.s)

Removes a header from the internal list of custom header field name/value pairs to be automatically added when HTTP requests are sent via methods that do not use the HTTP request object. (The SetRequestHeader method is called to add custom header fields.)

RenderGet

Declare.s ckRenderGet(obj.i, url.s)

Same as QuickGet, but does not send the HTTP GET. Instead, it builds the HTTP request that would've been sent and returns it.

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

More Information and Examples

RenderGet Example

ResumeDownload

Declare.i ckResumeDownload(obj.i, url.s, targetFilename.s)

Same as the Download method, except a failed download may be resumed. The targetFilename is automatically checked and if it exists, the download will resume at the point where it previously failed. ResumeDownload may be called any number of times until the full download is complete.

Returns 1 for success, 0 for failure.

ResumeDownloadAsync ⁽¹⁾

Declare.i ckResumeDownloadAsync(obj.i, url.s, targetFilename.s)

Creates an asynchronous task to call the ResumeDownload method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

ResumeDownloadBd

Declare.i ckResumeDownloadBd(obj.i, url.s, binData.i)

Introduced in version 9.5.0.75

Same as the DownloadBd method, except a failed download may be resumed. The download will resume at a point based on the number of bytes already contained in binData. ResumeDownloadBd may be called any number of times until the full download is complete.

The incoming data is appended to binData.

Returns 1 for success, 0 for failure.

ResumeDownloadBdAsync ⁽¹⁾

Declare.i ckResumeDownloadBdAsync(obj.i, url.s, binData.i)

Introduced in version 9.5.0.75

Creates an asynchronous task to call the ResumeDownloadBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

S3_CreateBucket

Declare.i ckS3_CreateBucket(obj.i, bucketPath.s)

Creates a new Amazon S3 bucket.

Note: x-amz-* headers, including metadata, can be added to any S3 request by adding each header with a call to SetRequestHeader. This applies to all S3 methods, even if not explicitly stated.

Returns 1 for success, 0 for failure.

More Information and Examples

S3 Create Bucket Example

S3_CreateBucketAsync ⁽¹⁾

Declare.i ckS3_CreateBucketAsync(obj.i, bucketPath.s)

Creates an asynchronous task to call the S3_CreateBucket method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

S3_DeleteBucket

Declare.i ckS3_DeleteBucket(obj.i, bucketPath.s)

Deletes an Amazon S3 bucket.

Note: If the bucket is in a region different than us-east-1, makes sure to set the AwsEndpoint property to the correct region, such as "eu-central-1". Also, if using an S3 compatible service such as Wasabi, always set the AwsEndpoint property. For example: "s3.wasabisys.com", "s3.eu-central-1.wasabisys.com".

Returns 1 for success, 0 for failure.

More Information and Examples

S3 Delete Bucket

S3_DeleteBucketAsync ⁽¹⁾

Declare.i ckS3_DeleteBucketAsync(obj.i, bucketPath.s)

Creates an asynchronous task to call the S3_DeleteBucket method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

S3_DeleteMultipleObjects

Declare.i ckS3_DeleteMultipleObjects(obj.i, bucketName.s, objectNames.i)

Introduced in version 9.5.0.47

Deletes multiple objects from a bucket using a single HTTP request. The bucketName contains the names (also known as "keys") of the objects to be deleted. To delete a specific version of an object, append a versionId attribute to the object name. For example: "SampleDocument.txt; VersionId="OYcLXagmS.WaD..oyH4KRguB95_YhLs7""

Returns 0 on failure

More Information and Examples

Delete Multiple Objects Example

S3_DeleteMultipleObjectsAsync ^{(1) (2)}

Declare.i ckS3_DeleteMultipleObjectsAsync(obj.i, bucketName.s, objectNames.i)

Introduced in version 9.5.0.47

Creates an asynchronous task to call the S3_DeleteMultipleObjects method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

S3_DeleteObject

Declare.i ckS3_DeleteObject(obj.i, bucketPath.s, objectName.s)

Deletes a remote file (object) on the Amazon S3 service.

Returns 1 for success, 0 for failure.

More Information and Examples

S3_DeleteObjectAsync ⁽¹⁾

Declare.i ckS3_DeleteObjectAsync(obj.i, bucketPath.s, objectName.s)

Creates an asynchronous task to call the S3_DeleteObject method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

S3_DownloadBd

Declare.i ckS3_DownloadBd(obj.i, bucketPath.s, objectName.s, bd.i)

Introduced in version 9.5.0.76

The same as DownloadFile, except the downloaded file data is appended to bd.

Note: If the bucket is in a region different than us-east-1, makes sure to set the AwsEndpoint property to the correct region, such as "eu-central-1". Also, if using an S3 compatible service such as Wasabi, always set the AwsEndpoint property. For example: "s3.wasabisys.com", "s3.eu-central-1.wasabisys.com".

Returns 1 for success, 0 for failure.

S3_DownloadBdAsync ⁽¹⁾

Declare.i ckS3_DownloadBdAsync(obj.i, bucketPath.s, objectName.s, bd.i)

Introduced in version 9.5.0.76

Creates an asynchronous task to call the S3_DownloadBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

S3_DownloadFile

Declare.i ckS3_DownloadFile(obj.i, bucketPath.s, objectName.s, localFilePath.s)

Downloads a file from the Amazon S3 service.

Note: If the bucket is in a region different than us-east-1, makes sure to set the AwsEndpoint property to the correct region, such as "eu-central-1". Also, if using an S3 compatible service such as Wasabi, always set the AwsEndpoint property. For example: "s3.wasabisys.com", "s3.eu-central-1.wasabisys.com".

Returns 1 for success, 0 for failure.

More Information and Examples

S3 Download File Example

S3_DownloadFileAsync ⁽¹⁾

Declare.i ckS3_DownloadFileAsync(obj.i, bucketPath.s, objectName.s, localFilePath.s)

Creates an asynchronous task to call the S3_DownloadFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

S3_DownloadString

Declare.s ckS3_DownloadString(obj.i, bucketPath.s, objectName.s, charset.s)

Downloads a text file (object) from the Amazon S3 service directly into a string variable. The charset specifies the character encoding, such as "utf-8", of the remote text object.

Note: If the bucket is in a region different than us-east-1, makes sure to set the AwsEndpoint property to the correct region, such as "eu-central-1". Also, if using an S3 compatible service such as Wasabi, always set the AwsEndpoint property. For example: "s3.wasabisys.com", "s3.eu-central-1.wasabisys.com".

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

More Information and Examples

S3 Download String Object

S3_DownloadStringAsync ⁽¹⁾

Declare.i ckS3_DownloadStringAsync(obj.i, bucketPath.s, objectName.s, charset.s)

Creates an asynchronous task to call the S3_DownloadString method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

S3_FileExists

Declare.i ckS3_FileExists(obj.i, bucketPath.s, objectName.s)

Determines if a remote object (file) exists. Returns 1 if the file exists, 0 if it does not exist, -1 if there was a failure in checking, or 2 if using in asynchronous mode to indicate that the background task was successfully started.

Note: If the bucket is in a region different than us-east-1, makes sure to set the AwsEndpoint property to the correct region, such as "eu-central-1". Also, if using an S3 compatible service such as Wasabi, always set the AwsEndpoint property. For example: "s3.wasabisys.com", "s3.eu-central-1.wasabisys.com".

More Information and Examples

Read S3 Object Metadata of File Already Uploaded to S3

S3_FileExistsAsync ⁽¹⁾

Declare.i ckS3_FileExistsAsync(obj.i, bucketPath.s, objectName.s)

Creates an asynchronous task to call the S3_FileExists method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

S3_GenerateUrl

Declare.s ckS3_GenerateUrl(obj.i, bucket.s, path.s, expire.i)

Introduced in version 9.5.0.46

Generates a temporary pre-signed URL for Amazon S3 using AWS Signature V2. (Call S3_GenerateUrlV4 to generate AWS Signature V4 pre-signed URLs.) Requires that the AwsSecretKey and AwsAccessKey be set to valid values prior to calling this method.

Note: This method can only generate URLs that are for HTTP GET requests (i.e. URLs you can paste into a browser address bar). This method does not generate URLs for POST, PUT, DELETE, etc.

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

More Information and Examples

Generate S3 Signed URL

S3_GenerateUrlV4

Declare.s ckS3_GenerateUrlV4(obj.i, useHttps.l, bucketName.s, path.s, numSecondsValid.l, awsService.s)

Introduced in version 9.5.0.66

Note: The S3_GenPresignedUrl method is new in Chilkat v9.5.0.83 and can create S3 pre-signed URLs for GET, POST, PUT, DELETE, or any other HTTP verb.

Generates a temporary pre-signed URL for Amazon S3 using AWS Signature V4. (Call S3_GenerateUrl to generate AWS Signature V2 pre-signed URLs.) Requires that the AwsSecretKey, AwsAccessKey, and AwsRegion properties be set to valid values prior to calling this method. Also requires the AwsEndpoint property to be set if the endpoint is different than "s3.amazonaws.com".

The URL that is generated has this format:

https://<AwsEndpoint>/<bucket_name>/<path>
?X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=<AwsAccessKey>/<currentDate>/<AwsRegion>/<awsService>/aws4_request
&X-Amz-Date=<currentDateTime>
&X-Amz-Expires=<numSecondsValid>
&X-Amz-SignedHeaders=host
&X-Amz-Signature=<signature-value>

The awsService is a string naming the AWS service, such as "s3". If useHttps is 1, then the URL begins with "https://", otherwise it begins with "http://".

Note: This method can only generate URLs that are for HTTP GET requests (i.e. URLs you can paste into a browser address bar). This method does not generate URLs for POST, PUT, DELETE, etc.

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

More Information and Examples

Generate an AWS (S3) Pre-Signed URL using Signature V4

S3_GenPresignedUrl

Declare.s ckS3_GenPresignedUrl(obj.i, httpVerb.s, useHttps.l, bucketName.s, path.s, numSecondsValid.l, awsService.s)

Introduced in version 9.5.0.83

Generates a temporary pre-signed URL for Amazon S3 using AWS Signature V4. Requires that the AwsSecretKey, AwsAccessKey, and AwsRegion properties be set to valid values prior to calling this method. Also requires the AwsEndpoint property to be set if the endpoint is different than "s3.amazonaws.com".

The URL that is generated has this format:

https://<AwsEndpoint>/<bucket_name>/<path>
?X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=<AwsAccessKey>/<currentDate>/<AwsRegion>/<awsService>/aws4_request
&X-Amz-Date=<currentDateTime>
&X-Amz-Expires=<numSecondsValid>
&X-Amz-SignedHeaders=host
&X-Amz-Signature=<signature-value>

The httpVerb is the HTTP verb such as "GET", "PUT", "POST", "DELETE", etc. The awsService is a string naming the AWS service, such as "s3" or "s3-accelerate". If useHttps is 1, then the URL begins with "https://", otherwise it begins with "http://".

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

More Information and Examples

Create S3 Pre-Signed URL for Upload S3 Upload with Transfer Acceleration

S3_ListBucketObjects

Declare.s ckS3_ListBucketObjects(obj.i, bucketPath.s)

Retrieves the XML listing of the objects contained within an Amazon S3 bucket. (This is like a directory listing, but in XML format.)

The bucketPath name may be qualified with URL-encoded params. For example, to list the objects in a bucket named "ChilkatABC" with max-keys = 2000 and marker = "xyz", call S3_ListBucketObject passing the following string for bucketPath: "ChilkatABC?max-keys=2000&marker=xyz"

The S3_ListBucketObjects method recognized all params listed in the AWS documentation for listing objects in a bucket: delimiter, marker, max-keys, and prefix. See Amazon's AWS online documentation for more information.

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

More Information and Examples

S3 List Objects in Bucket

S3_ListBucketObjectsAsync ⁽¹⁾

Declare.i ckS3_ListBucketObjectsAsync(obj.i, bucketPath.s)

Creates an asynchronous task to call the S3_ListBucketObjects method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

S3_ListBuckets

Declare.s ckS3_ListBuckets(obj.i)

Retrieves the XML listing of the buckets for an Amazon S3 account.

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

More Information and Examples

S3 List Buckets Example

S3_ListBucketsAsync ⁽¹⁾

Declare.i ckS3_ListBucketsAsync(obj.i)

Creates an asynchronous task to call the S3_ListBuckets method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

S3_UploadBd

Declare.i ckS3_UploadBd(obj.i, bd.i, contentType.s, bucketPath.s, objectName.s)

Introduced in version 9.5.0.76

The same as S3_UploadFile, except the contents of the file come from bd instead of a local file.

Note: x-amz-* headers, including metadata, can be added to any S3 request by adding each header with a call to SetRequestHeader. This applies to all S3 methods, even if not explicitly stated.

Note: If the bucket is in a region different than us-east-1, makes sure to set the AwsEndpoint property to the correct region, such as "eu-central-1". Also, if using an S3 compatible service such as Wasabi, always set the AwsEndpoint property. For example: "s3.wasabisys.com", "s3.eu-central-1.wasabisys.com".

Returns 1 for success, 0 for failure.

More Information and Examples

Backblaze S3 Upload Binary

S3_UploadBdAsync ⁽¹⁾

Declare.i ckS3_UploadBdAsync(obj.i, bd.i, contentType.s, bucketPath.s, objectName.s)

Introduced in version 9.5.0.76

Creates an asynchronous task to call the S3_UploadBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

S3_UploadFile

Declare.i ckS3_UploadFile(obj.i, localFilePath.s, contentType.s, bucketPath.s, objectName.s)

Uploads a file to the Amazon S3 service.

Note: x-amz-* headers, including metadata, can be added to any S3 request by adding each header with a call to SetRequestHeader. This applies to all S3 methods, even if not explicitly stated.

Note: If the bucket is in a region different than us-east-1, makes sure to set the AwsEndpoint property to the correct region, such as "eu-central-1". Also, if using an S3 compatible service such as Wasabi, always set the AwsEndpoint property. For example: "s3.wasabisys.com", "s3.eu-central-1.wasabisys.com".

Returns 1 for success, 0 for failure.

More Information and Examples

S3 Upload File Wasabi Upload File

S3_UploadFileAsync ⁽¹⁾

Declare.i ckS3_UploadFileAsync(obj.i, localFilePath.s, contentType.s, bucketPath.s, objectName.s)

Creates an asynchronous task to call the S3_UploadFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

S3_UploadString

Declare.i ckS3_UploadString(obj.i, objectContent.s, charset.s, contentType.s, bucketPath.s, objectName.s)

Uploads an in-memory string to the Amazon S3 service. This is the same as UploadFile, except that the file contents are from an in-memory string instead of a local file. Internal to this method, the objectContent is converted to the character encoding specified by charset prior to uploading.

Note: x-amz-* headers, including metadata, can be added to any S3 request by adding each header with a call to SetRequestHeader. This applies to all S3 methods, even if not explicitly stated.

Note: If the bucket is in a region different than us-east-1, makes sure to set the AwsEndpoint property to the correct region, such as "eu-central-1". Also, if using an S3 compatible service such as Wasabi, always set the AwsEndpoint property. For example: "s3.wasabisys.com", "s3.eu-central-1.wasabisys.com".

Returns 1 for success, 0 for failure.

More Information and Examples

S3 Upload String

S3_UploadStringAsync ⁽¹⁾

Declare.i ckS3_UploadStringAsync(obj.i, objectContent.s, charset.s, contentType.s, bucketPath.s, objectName.s)

Creates an asynchronous task to call the S3_UploadString method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

SetAuthPrivateKey

Declare.i ckSetAuthPrivateKey(obj.i, publicKeyId.s, privKey.i)

Introduced in version 9.5.0.89

Sets the private key to be used with some forms of authentication. Starting in v9.5.0.89, this is used automatically add the Authorization header (Signature) for Amazon Pay requests.

Returns 1 for success, 0 for failure.

More Information and Examples

Amazon Pay Examples

SetAuthTokenSb

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

Introduced in version 9.5.0.95

Sets the AuthToken property. The sb contains the OAuth2 access token to be used.

Returns 1 for success, 0 for failure.

SetCookieXml

Declare.i ckSetCookieXml(obj.i, domain.s, cookieXml.s)

Restores cookies for a particular domain. It is assumed that the cookie XML was previously retrieved via the GetCookieXml method, and saved to some sort of persistent storage, such as within a database table. It is then possible for an application to restore the cookies by calling this method.

Returns 1 for success, 0 for failure.

SetOAuthRsaKey

Declare.i ckSetOAuthRsaKey(obj.i, privKey.i)

Introduced in version 9.5.0.39

Sets the RSA key to be used with OAuth authentication when the RSA-SHA1 OAuth signature method is used (see the OAuthSigMethod property).

Returns 1 for success, 0 for failure.

SetRequestHeader

Declare ckSetRequestHeader(obj.i, headerFieldName.s, headerFieldValue.s)

Adds a custom header field to any HTTP request sent by a method that does not use the HTTP request object. These methods include Download, DownloadAppend, GetHead, PostBinary, PostXml, PutBinary, PutText, QuickDeleteStr, QuickGet, QuickGetObj, QuickGetStr, QuickPutStr, XmlRpc, and XmlRpcPut.

Cookies may be explictly added by calling this method passing "Cookie" for the headerFieldName.

The RemoveRequestHeader method can be called to remove a custom header.

Note1: Do not call this method to add Basic authentication, i.e. "Authorization: Basic ....". Instead, set the Login and Password properties, and also set the BasicAuth property = 1. Chilkat will add the "Authorization: Basic ..." header using the correct format automatically.

Note 2: 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.)

Note 3: To add more than one header, call this method once per header field.

Note 4:: Passing an empty value string causes the header to be removed. This was the unfortunate behavior of the method from the beginning, and cannot be changed for backward compatibility reasons. A workaround exists starting in v9.5.0.82 by adding the "AllowEmptyHeaders" keyword to the UncommonOptions property.

More Information and Examples

Add Custom Header to HTTP GET

SetSecurePassword

Declare.i ckSetSecurePassword(obj.i, password.i)

Introduced in version 9.5.0.76

Equivalent to setting the Password property, but provides for a more secure way of passing the password in a secure string object.

Returns 1 for success, 0 for failure.

SetSslCertRequirement

Declare ckSetSslCertRequirement(obj.i, reqName.s, reqValue.s)

Introduced in version 9.5.0.84

Enforces a requirement on the server's certificate. The reqName can be one of the following:

SubjectDN
SubjectCN
IssuerDN
IssuerCN
SAN (added in v9.5.0.84)

The reqName specifies the part of the certificate, and the reqValue is the value that it must match exactly or with a wildcard (*). If the server's certificate does not match, the SSL / TLS connection is aborted.

Returns 1 for success, 0 for failure.

More Information and Examples

Require SSL Server Certificate Domain Match

SetSslClientCert

Declare.i ckSetSslClientCert(obj.i, cert.i)

Allows for a client-side certificate to be used for an SSL connection.

Returns 1 for success, 0 for failure.

More Information and Examples

HTTP TLS Mutual Authentication (Client-Side Certificate)Use Installed Cert on Windows for TLS Client Authentication Rabobank GET /v3/accounts HTTPS Mutual Authentication using Smartcard or Token

SetSslClientCertPem

Declare.i ckSetSslClientCertPem(obj.i, pemDataOrPath.s, pemPassword.s)

Allows for a client-side certificate + private key to be used for the SSL / TLS connection (often called 2-way SSL).

Returns 1 for success, 0 for failure.

More Information and Examples

How to Create a PEM that Contains Certificates and a Private Key HTTP TLS Mutual Authentication (Client-Side Certificate)

SetSslClientCertPfx

Declare.i ckSetSslClientCertPfx(obj.i, pfxPath.s, pfxPassword.s)

Allows for a client-side certificate + private key to be used for the SSL / TLS connection (often called 2-way SSL).

Returns 1 for success, 0 for failure.

More Information and Examples

HTTP TLS Mutual Authentication (Client-Side Certificate)

SetUrlVar

Declare.i ckSetUrlVar(obj.i, name.s, value.s)

Introduced in version 9.5.0.67

Sets the value of a variable for substitutions in URLs passed to any method. Variables can appear in URLs in the following format: {$varName}. For example: https://graph.microsoft.com/v1.0/users/{$id}

Returns 1 for success, 0 for failure.

SharePointOnlineAuth

Declare.i ckSharePointOnlineAuth(obj.i, siteUrl.s, username.s, password.i, extraInfo.i)

Introduced in version 9.5.0.73

Authenticates with SharePoint Online, resulting in a cookie being set and used for subsequent SharePoint HTTP requests. Prior to calling this method, an application should set the CookieDir property to either "memory" or a directory path to persist the SharePoint authentication cookie to be automatically used in subsequent runs.

This method has the side-effect of setting the SaveCookies and SendCookies properties to 1, because these settings are required for SharePoint Online authentication.

The siteUrl is a URL such as "https://yourdomain.sharepoint.com/". The username is an email address such as "[email protected]". The extraInfo is reserved for providing additional information as needed in the future.

Returns 1 for success, 0 for failure.

More Information and Examples

SharePoint Online Authentication

SharePointOnlineAuthAsync ⁽¹⁾

Declare.i ckSharePointOnlineAuthAsync(obj.i, siteUrl.s, username.s, password.i, extraInfo.i)

Introduced in version 9.5.0.73

Creates an asynchronous task to call the SharePointOnlineAuth method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

SleepMs

Declare ckSleepMs(obj.i, millisec.l)

Convenience method to force the calling process to sleep for a number of milliseconds.

SynchronousRequest

Declare.i ckSynchronousRequest(obj.i, domain.s, port.l, ssl.l, req.i)

Sends an explicit HttpRequest to an HTTP server and returns an HttpResponse object. The HttpResponse object provides full access to the response including all headers and the response body. This method may be used to send POST requests, as well as GET, HEAD, file uploads, and XMLHTTP. To send via HTTPS (i.e. TLS), set the ssl property = 1. Otherwise set it to 0.

NOTE: The 1st argument of this method is a domain, not a URL. For example, DO NOT pass "https://www.somedomain.com/" in the 1st argument. Instead, pass "www.somedomain.com".

The Parts of a URL

http://example.com:8042/over/there?name=ferret#nose
\__/   \______________/\_________/ \________/ \__/
 |           |            |            |        |
scheme   domain+port     path        query   fragment

Returns 0 on failure

More Information and Examples

HTTP Tutorial - Common HTTP Requests Explained How URL Syntax Relates to SynchronousRequest WebDAV PROPFIND using SynchronousRequest Simple HTTP POST Debugging HTTP Send XMLHttpRequest using PUT, GET, DELETE, or any HTTP Request Method Adding Cookies to an HTTP Request HTTP multipart/form-data Upload Parse a URL into its Component Parts SOAP with MTOM XOP Attachment

SynchronousRequestAsync ^{(1) (2)}

Declare.i ckSynchronousRequestAsync(obj.i, domain.s, port.l, ssl.l, req.i)

Creates an asynchronous task to call the SynchronousRequest method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

UrlDecode

Declare.s ckUrlDecode(obj.i, str.s)

URL decodes a string.

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

UrlEncode

Declare.s ckUrlEncode(obj.i, str.s)

URL encodes a string.

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

VerifyTimestampReply

Declare.i ckVerifyTimestampReply(obj.i, timestampReply.i, tsaCert.i)

Introduced in version 9.5.0.75

Verifies a timestamp reply received from a timestamp authority (TSA). Returns the following possible integer values:

-1: The timestampReply does not contain a valid timestamp reply.
-2: The timestampReply is a valid timestamp reply, but failed verification using the public key of the tsaCert.
0: Granted and verified.
1: Granted and verified, with mods (see RFC 3161)
2: Rejected.
3: Waiting.
4: Revocation Warning
5: Revocation Notification

If the timestamp reply (timestampReply) is known to be from a trusted source, then the tsaCert may be empty. If tsaCert is empty (never loaded with a certificate), then the verification will use the certificate embedded in the timestamp reply.

More Information and Examples

RFC3161 Timestamp Client - Fetch from Timestamp Authority (TSA) and Verify

XmlRpc

Declare.s ckXmlRpc(obj.i, urlEndpoint.s, xmlIn.s)

Makes an XML RPC call to a URL endpoint. The XML string is passed in an HTTP POST, and the XML response is returned.

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

More Information and Examples

HTTP XMLRPC Example

XmlRpcAsync ⁽¹⁾

Declare.i ckXmlRpcAsync(obj.i, urlEndpoint.s, xmlIn.s)

Creates an asynchronous task to call the XmlRpc method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

XmlRpcPut

Declare.s ckXmlRpcPut(obj.i, urlEndpoint.s, xmlIn.s)

Same as XmlRpc, but uses the HTTP PUT method instead of the POST method.

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

XmlRpcPutAsync ⁽¹⁾

Declare.i ckXmlRpcPutAsync(obj.i, urlEndpoint.s, xmlIn.s)

Creates an asynchronous task to call the XmlRpcPut method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure