HttpResponse Delphi DLL Reference Documentation

HttpResponse

Current Version: 9.5.0.75

Represents a complete HTTP response.

Create/Dispose

var
myObject: HCkHttpResponse;

begin
myObject := CkHttpResponse_Create();

// ...

CkHttpResponse_Dispose(myObject);
end;
function CkHttpResponse_Create: HCkHttpResponse; stdcall;

Creates an instance of the HCkHttpResponse object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

procedure CkHttpResponse_Dispose(handle: HCkHttpResponse); stdcall;

Objects created by calling CkHttpResponse_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.

Properties

Body
procedure CkHttpResponse_getBody(objHandle: HCkHttpResponse; outPropVal: HCkByteData); stdcall;

The response body returned as a byte array.

top
BodyQP
procedure CkHttpResponse_getBodyQP(objHandle: HCkHttpResponse; outPropVal: HCkString); stdcall;
function CkHttpResponse__bodyQP(objHandle: HCkHttpResponse): PWideChar; stdcall;

The same as the Body property, but returned as a quoted-printable encoded string.

top
BodyStr
procedure CkHttpResponse_getBodyStr(objHandle: HCkHttpResponse; outPropVal: HCkString); stdcall;
function CkHttpResponse__bodyStr(objHandle: HCkHttpResponse): PWideChar; stdcall;

The response body returned as a string.

top
Charset
procedure CkHttpResponse_getCharset(objHandle: HCkHttpResponse; outPropVal: HCkString); stdcall;
function CkHttpResponse__charset(objHandle: HCkHttpResponse): PWideChar; stdcall;

The response charset, such as "iso-8859-1", if applicable. Obviously, responses for GIF and JPG files will not have a charset.

top
ContentLength
function CkHttpResponse_getContentLength(objHandle: HCkHttpResponse): LongWord; stdcall;

The content length of the response, in bytes.

top
ContentLength64
function CkHttpResponse_getContentLength64(objHandle: HCkHttpResponse): Int64; stdcall;

The content length of the response, in number of bytes, returned as a 64-bit integer.

top
DateStr
procedure CkHttpResponse_getDateStr(objHandle: HCkHttpResponse; outPropVal: HCkString); stdcall;
function CkHttpResponse__dateStr(objHandle: HCkHttpResponse): PWideChar; stdcall;

Returns the content of the Date response header field in RFC822 date/time string format.

top
DebugLogFilePath
procedure CkHttpResponse_getDebugLogFilePath(objHandle: HCkHttpResponse; outPropVal: HCkString); stdcall;
procedure CkHttpResponse_putDebugLogFilePath(objHandle: HCkHttpResponse; newPropVal: PWideChar); stdcall;
function CkHttpResponse__debugLogFilePath(objHandle: HCkHttpResponse): PWideChar; stdcall;

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

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

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

top
Domain
procedure CkHttpResponse_getDomain(objHandle: HCkHttpResponse; outPropVal: HCkString); stdcall;
function CkHttpResponse__domain(objHandle: HCkHttpResponse): PWideChar; stdcall;

The domain of the HTTP server that created this response.

top
FinalRedirectUrl
procedure CkHttpResponse_getFinalRedirectUrl(objHandle: HCkHttpResponse; outPropVal: HCkString); stdcall;
function CkHttpResponse__finalRedirectUrl(objHandle: HCkHttpResponse): PWideChar; stdcall;
Introduced in version 9.5.0.49

Returns the redirect URL for 301/302 responses.

top
FullMime
procedure CkHttpResponse_getFullMime(objHandle: HCkHttpResponse; outPropVal: HCkString); stdcall;
function CkHttpResponse__fullMime(objHandle: HCkHttpResponse): PWideChar; stdcall;

Returns the full MIME (header + body) of the HTTP response.

top
Header
procedure CkHttpResponse_getHeader(objHandle: HCkHttpResponse; outPropVal: HCkString); stdcall;
function CkHttpResponse__header(objHandle: HCkHttpResponse): PWideChar; stdcall;

The full text of the response header.

top
LastErrorHtml
procedure CkHttpResponse_getLastErrorHtml(objHandle: HCkHttpResponse; outPropVal: HCkString); stdcall;
function CkHttpResponse__lastErrorHtml(objHandle: HCkHttpResponse): PWideChar; stdcall;

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

top
LastErrorText
procedure CkHttpResponse_getLastErrorText(objHandle: HCkHttpResponse; outPropVal: HCkString); stdcall;
function CkHttpResponse__lastErrorText(objHandle: HCkHttpResponse): PWideChar; stdcall;

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

top
LastErrorXml
procedure CkHttpResponse_getLastErrorXml(objHandle: HCkHttpResponse; outPropVal: HCkString); stdcall;
function CkHttpResponse__lastErrorXml(objHandle: HCkHttpResponse): PWideChar; stdcall;

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

top
LastMethodSuccess
function CkHttpResponse_getLastMethodSuccess(objHandle: HCkHttpResponse): wordbool; stdcall;
procedure CkHttpResponse_putLastMethodSuccess(objHandle: HCkHttpResponse; newPropVal: wordbool); stdcall;
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of True indicates success, a value of False 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 = True and failure = False.
  • 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 True. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
NumCookies
function CkHttpResponse_getNumCookies(objHandle: HCkHttpResponse): Integer; stdcall;

The number of cookies included in the response.

top
NumHeaderFields
function CkHttpResponse_getNumHeaderFields(objHandle: HCkHttpResponse): Integer; stdcall;

The number of response header fields.

top
StatusCode
function CkHttpResponse_getStatusCode(objHandle: HCkHttpResponse): Integer; stdcall;

The status code (as an integer) from the first line of an HTTP response. If the StatusLine = "HTTP/1.0 200 OK", the response status code returned is 200.

top
StatusLine
procedure CkHttpResponse_getStatusLine(objHandle: HCkHttpResponse; outPropVal: HCkString); stdcall;
function CkHttpResponse__statusLine(objHandle: HCkHttpResponse): PWideChar; stdcall;

The first line of an HTTP response, such as "HTTP/1.0 200 OK".

top
StatusText
procedure CkHttpResponse_getStatusText(objHandle: HCkHttpResponse; outPropVal: HCkString); stdcall;
function CkHttpResponse__statusText(objHandle: HCkHttpResponse): PWideChar; stdcall;
Introduced in version 9.5.0.49

The text that follows the status code in the 1st line of the HTTP response. For example, i the first line of an HTTP response is "HTTP/1.0 200 OK", then this property contains "OK".

top
VerboseLogging
function CkHttpResponse_getVerboseLogging(objHandle: HCkHttpResponse): wordbool; stdcall;
procedure CkHttpResponse_putVerboseLogging(objHandle: HCkHttpResponse; newPropVal: wordbool); stdcall;

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

top
Version
procedure CkHttpResponse_getVersion(objHandle: HCkHttpResponse; outPropVal: HCkString); stdcall;
function CkHttpResponse__version(objHandle: HCkHttpResponse): PWideChar; stdcall;

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

top

Methods

GetBodyBd
function CkHttpResponse_GetBodyBd(objHandle: HCkHttpResponse;
    binData: HCkBinData): wordbool; stdcall;
Introduced in version 9.5.0.64

Copies the response body to a BinData object.

Returns True for success, False for failure.

top
GetBodySb
function CkHttpResponse_GetBodySb(objHandle: HCkHttpResponse;
    sb: HCkStringBuilder): wordbool; stdcall;
Introduced in version 9.5.0.64

Copies the response body to a Chilkat StringBuilder object.

Returns True for success, False for failure.

top
GetCookieDomain
function CkHttpResponse_GetCookieDomain(objHandle: HCkHttpResponse;
    index: Integer;
    outStr: HCkString): wordbool; stdcall;
function CkHttpResponse__getCookieDomain(objHandle: HCkHttpResponse;
    index: Integer): PWideChar; stdcall;

Returns the domain of the Nth cookie in the response. Indexing begins at 0. The number of response cookies is specified in the NumCookies property.

Returns True for success, False for failure.

top
GetCookieExpiresStr
function CkHttpResponse_GetCookieExpiresStr(objHandle: HCkHttpResponse;
    index: Integer;
    outStr: HCkString): wordbool; stdcall;
function CkHttpResponse__getCookieExpiresStr(objHandle: HCkHttpResponse;
    index: Integer): PWideChar; stdcall;

Returns the expiration date/time of the Nth cookie in the response. Indexing begins at 0. The number of response cookies is specified in the NumCookies property.

Returns True for success, False for failure.

top
GetCookieName
function CkHttpResponse_GetCookieName(objHandle: HCkHttpResponse;
    index: Integer;
    outStr: HCkString): wordbool; stdcall;
function CkHttpResponse__getCookieName(objHandle: HCkHttpResponse;
    index: Integer): PWideChar; stdcall;

Returns the name of the Nth cookie returned in the response. Indexing begins at 0. The number of response cookies is specified in the NumCookies property.

Returns True for success, False for failure.

top
GetCookiePath
function CkHttpResponse_GetCookiePath(objHandle: HCkHttpResponse;
    index: Integer;
    outStr: HCkString): wordbool; stdcall;
function CkHttpResponse__getCookiePath(objHandle: HCkHttpResponse;
    index: Integer): PWideChar; stdcall;

Returns the path of the Nth cookie returned in the response. Indexing begins at 0. The number of response cookies is specified in the NumCookies property.

Returns True for success, False for failure.

top
GetCookieValue
function CkHttpResponse_GetCookieValue(objHandle: HCkHttpResponse;
    index: Integer;
    outStr: HCkString): wordbool; stdcall;
function CkHttpResponse__getCookieValue(objHandle: HCkHttpResponse;
    index: Integer): PWideChar; stdcall;

Returns the value of the Nth cookie returned in the response. Indexing begins at 0. The number of response cookies is specified in the NumCookies property.

Returns True for success, False for failure.

top
GetHeaderField
function CkHttpResponse_GetHeaderField(objHandle: HCkHttpResponse;
    fieldName: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkHttpResponse__getHeaderField(objHandle: HCkHttpResponse;
    fieldName: PWideChar): PWideChar; stdcall;

Returns the value of a response header field accessed by field name.

Returns True for success, False for failure.

top
GetHeaderFieldAttr
function CkHttpResponse_GetHeaderFieldAttr(objHandle: HCkHttpResponse;
    fieldName: PWideChar;
    attrName: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkHttpResponse__getHeaderFieldAttr(objHandle: HCkHttpResponse;
    fieldName: PWideChar;
    attrName: PWideChar): PWideChar; stdcall;

Returns a response header field attribute. As an example, the response charset is simply the GetHeaderFieldAttr("content-type","charset")

Returns True for success, False for failure.

top
GetHeaderName
function CkHttpResponse_GetHeaderName(objHandle: HCkHttpResponse;
    index: Integer;
    outStr: HCkString): wordbool; stdcall;
function CkHttpResponse__getHeaderName(objHandle: HCkHttpResponse;
    index: Integer): PWideChar; stdcall;

Gets the name of the Nth response header field. Indexing begins at 0. The number of response headers is specified by the NumHeaderFields property.

Returns True for success, False for failure.

top
GetHeaderValue
function CkHttpResponse_GetHeaderValue(objHandle: HCkHttpResponse;
    index: Integer;
    outStr: HCkString): wordbool; stdcall;
function CkHttpResponse__getHeaderValue(objHandle: HCkHttpResponse;
    index: Integer): PWideChar; stdcall;

Gets the value of the Nth response header field. Indexing begins at 0. The number of response headers is specified by the NumHeaderFields property.

Returns True for success, False for failure.

top
LoadTaskResult
function CkHttpResponse_LoadTaskResult(objHandle: HCkHttpResponse;
    task: HCkTask): wordbool; stdcall;
Introduced in version 9.5.0.52

Loads the HTTP response from a completed asynchronous task. A failed return value indicates that no HTTP response was received in the HTTP asynchronous method call (i.e. the asynchronous HTTP request failed in such a way that no response was received).

Returns True for success, False for failure.

top
SaveBodyBinary
function CkHttpResponse_SaveBodyBinary(objHandle: HCkHttpResponse;
    path: PWideChar): wordbool; stdcall;

Saves the body of the HTTP response to a file.

Returns True for success, False for failure.

top
SaveBodyText
function CkHttpResponse_SaveBodyText(objHandle: HCkHttpResponse;
    bCrlf: wordbool;
    path: PWideChar): wordbool; stdcall;

Saves the HTTP response body to a file. This method provides control over CRLF vs bare-LF line-endings. If bCrlf is True, then line endings are automatically converted to CRLF if necessary. If bCrlf is False, then line-endings are automatically converted to bare-LF's (Unix style) if necessary.

To save the HTTP response body exactly as-is (with no line-ending manipulation), then call SaveBodyBinary.

Returns True for success, False for failure.

top
SaveLastError
function CkHttpResponse_SaveLastError(objHandle: HCkHttpResponse;
    path: PWideChar): wordbool; stdcall;

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

Returns True for success, False for failure.

top
UrlEncParamValue
function CkHttpResponse_UrlEncParamValue(objHandle: HCkHttpResponse;
    encodedParamString: PWideChar;
    paramName: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkHttpResponse__urlEncParamValue(objHandle: HCkHttpResponse;
    encodedParamString: PWideChar;
    paramName: PWideChar): PWideChar; stdcall;

Convenience method for parsing a param's value out of a URL-encoded param string. For example, if a caller passes the following string in encodedParamString:

oauth_token=ABC&oauth_token_secret=123&oauth_callback_confirmed=true
and "oauth_token_secret" in paramName, then the return value would be "123".

Returns True for success, False for failure.

top