Cgi Delphi DLL Reference Documentation

Cgi

Deprecated To be removed in a future version, and should no longer be used.

Current Version: 10.1.3

Provides the ability to receive HTTP requests and all associated parameters, HTTP header fields, etc. A common use is for receiving HTTP uploads. Provides the ability to receive uploads that stream directly to disk, eliminating memory requirements for large files. Also provides the ability to receive uploaded files directly in memory.

Create/Dispose

var
myObject: HCkCgi;

begin
myObject := CkCgi_Create();

// ...

CkCgi_Dispose(myObject);
end;

function CkCgi_Create: HCkCgi; stdcall;

Creates an instance of the HCkCgi 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 CkCgi_Dispose(handle: HCkCgi); stdcall;

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

Properties

AsyncBytesRead

function CkCgi_getAsyncBytesRead(objHandle: HCkCgi): Integer; stdcall;

To be documented soon...

AsyncInProgress

function CkCgi_getAsyncInProgress(objHandle: HCkCgi): wordbool; stdcall;

To be documented soon...

AsyncPostSize

function CkCgi_getAsyncPostSize(objHandle: HCkCgi): Integer; stdcall;

To be documented soon...

AsyncSuccess

function CkCgi_getAsyncSuccess(objHandle: HCkCgi): wordbool; stdcall;

To be documented soon...

DebugLogFilePath

procedure CkCgi_getDebugLogFilePath(objHandle: HCkCgi; outPropVal: HCkString); stdcall;
procedure CkCgi_putDebugLogFilePath(objHandle: HCkCgi; newPropVal: PWideChar); stdcall;
function CkCgi__debugLogFilePath(objHandle: HCkCgi): PWideChar; stdcall;

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

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

Possible causes of hangs include:

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

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Example showing how to use DebugLogFilePath.

HeartbeatMs

function CkCgi_getHeartbeatMs(objHandle: HCkCgi): Integer; stdcall;
procedure CkCgi_putHeartbeatMs(objHandle: HCkCgi; newPropVal: Integer); stdcall;

To be documented soon...

IdleTimeoutMs

function CkCgi_getIdleTimeoutMs(objHandle: HCkCgi): Integer; stdcall;
procedure CkCgi_putIdleTimeoutMs(objHandle: HCkCgi; newPropVal: Integer); stdcall;

To be documented soon...

LastErrorHtml

procedure CkCgi_getLastErrorHtml(objHandle: HCkCgi; outPropVal: HCkString); stdcall;
function CkCgi__lastErrorHtml(objHandle: HCkCgi): PWideChar; stdcall;

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

See the notes about PWideChar memory ownership and validity.

LastErrorText

procedure CkCgi_getLastErrorText(objHandle: HCkCgi; outPropVal: HCkString); stdcall;
function CkCgi__lastErrorText(objHandle: HCkCgi): PWideChar; stdcall;

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

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

procedure CkCgi_getLastErrorXml(objHandle: HCkCgi; outPropVal: HCkString); stdcall;
function CkCgi__lastErrorXml(objHandle: HCkCgi): PWideChar; stdcall;

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

See the notes about PWideChar memory ownership and validity.

LastMethodSuccess

function CkCgi_getLastMethodSuccess(objHandle: HCkCgi): wordbool; stdcall;
procedure CkCgi_putLastMethodSuccess(objHandle: HCkCgi; newPropVal: wordbool); stdcall;

Indicates the success or failure of the most recent method call: True means success, False means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

NumParams

function CkCgi_getNumParams(objHandle: HCkCgi): Integer; stdcall;

To be documented soon...

NumUploadFiles

function CkCgi_getNumUploadFiles(objHandle: HCkCgi): Integer; stdcall;

To be documented soon...

ReadChunkSize

function CkCgi_getReadChunkSize(objHandle: HCkCgi): Integer; stdcall;
procedure CkCgi_putReadChunkSize(objHandle: HCkCgi; newPropVal: Integer); stdcall;

To be documented soon...

SizeLimitKB

function CkCgi_getSizeLimitKB(objHandle: HCkCgi): Integer; stdcall;
procedure CkCgi_putSizeLimitKB(objHandle: HCkCgi; newPropVal: Integer); stdcall;

To be documented soon...

StreamToUploadDir

function CkCgi_getStreamToUploadDir(objHandle: HCkCgi): wordbool; stdcall;
procedure CkCgi_putStreamToUploadDir(objHandle: HCkCgi; newPropVal: wordbool); stdcall;

To be documented soon...

UploadDir

procedure CkCgi_getUploadDir(objHandle: HCkCgi; outPropVal: HCkString); stdcall;
procedure CkCgi_putUploadDir(objHandle: HCkCgi; newPropVal: PWideChar); stdcall;
function CkCgi__uploadDir(objHandle: HCkCgi): PWideChar; stdcall;

To be documented soon...

See the notes about PWideChar memory ownership and validity.

VerboseLogging

function CkCgi_getVerboseLogging(objHandle: HCkCgi): wordbool; stdcall;
procedure CkCgi_putVerboseLogging(objHandle: HCkCgi; 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.

Version

procedure CkCgi_getVersion(objHandle: HCkCgi; outPropVal: HCkString); stdcall;
function CkCgi__version(objHandle: HCkCgi): PWideChar; stdcall;

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

See the notes about PWideChar memory ownership and validity.

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AbortAsync

procedure CkCgi_AbortAsync(objHandle: HCkCgi) stdcall;

To be documented soon...

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

AsyncReadRequest

function CkCgi_AsyncReadRequest(objHandle: HCkCgi): wordbool; stdcall;

To be documented soon...

GetEnv

function CkCgi_GetEnv(objHandle: HCkCgi;
    varName: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkCgi__getEnv(objHandle: HCkCgi;
    varName: PWideChar): PWideChar; stdcall;

To be documented soon...

Returns True for success, False for failure.

See the notes about PWideChar memory ownership and validity.

GetParam

function CkCgi_GetParam(objHandle: HCkCgi;
    paramName: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkCgi__getParam(objHandle: HCkCgi;
    paramName: PWideChar): PWideChar; stdcall;

To be documented soon...

Returns True for success, False for failure.

See the notes about PWideChar memory ownership and validity.

GetParamName

function CkCgi_GetParamName(objHandle: HCkCgi;
    index: Integer;
    outStr: HCkString): wordbool; stdcall;
function CkCgi__getParamName(objHandle: HCkCgi;
    index: Integer): PWideChar; stdcall;

To be documented soon...

Returns True for success, False for failure.

See the notes about PWideChar memory ownership and validity.

GetParamValue

function CkCgi_GetParamValue(objHandle: HCkCgi;
    index: Integer;
    outStr: HCkString): wordbool; stdcall;
function CkCgi__getParamValue(objHandle: HCkCgi;
    index: Integer): PWideChar; stdcall;

To be documented soon...

Returns True for success, False for failure.

See the notes about PWideChar memory ownership and validity.

GetRawPostData

function CkCgi_GetRawPostData(objHandle: HCkCgi;
outData: HCkByteData): wordbool; stdcall;

To be documented soon...

Returns True for success, False for failure.

GetUploadData

function CkCgi_GetUploadData(objHandle: HCkCgi;
index: Integer;
outData: HCkByteData): wordbool; stdcall;

To be documented soon...

Returns True for success, False for failure.

GetUploadFilename

function CkCgi_GetUploadFilename(objHandle: HCkCgi;
    index: Integer;
    outStr: HCkString): wordbool; stdcall;
function CkCgi__getUploadFilename(objHandle: HCkCgi;
    index: Integer): PWideChar; stdcall;

To be documented soon...

Returns True for success, False for failure.

See the notes about PWideChar memory ownership and validity.

GetUploadSize

function CkCgi_GetUploadSize(objHandle: HCkCgi;
index: Integer): Integer; stdcall;

To be documented soon...

IsGet

function CkCgi_IsGet(objHandle: HCkCgi): wordbool; stdcall;

To be documented soon...

IsHead

function CkCgi_IsHead(objHandle: HCkCgi): wordbool; stdcall;

To be documented soon...

IsPost

function CkCgi_IsPost(objHandle: HCkCgi): wordbool; stdcall;

To be documented soon...

IsUpload

function CkCgi_IsUpload(objHandle: HCkCgi): wordbool; stdcall;

To be documented soon...

ReadRequest

function CkCgi_ReadRequest(objHandle: HCkCgi): wordbool; stdcall;

To be documented soon...

SaveNthToUploadDir

function CkCgi_SaveNthToUploadDir(objHandle: HCkCgi;
index: Integer): wordbool; stdcall;

To be documented soon...

SleepMs

procedure CkCgi_SleepMs(objHandle: HCkCgi;
millisec: Integer) stdcall;

To be documented soon...

TestConsumeAspUpload

function CkCgi_TestConsumeAspUpload(objHandle: HCkCgi;
path: PWideChar): wordbool; stdcall;

To be documented soon...