Cgi Delphi DLL Reference Documentation

Cgi

Current Version: 9.5.0.72

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...

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

To be documented soon...

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

To be documented soon...

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

To be documented soon...

top
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, 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
IdleTimeoutMs
function CkCgi_getIdleTimeoutMs(objHandle: HCkCgi): Integer; stdcall;
procedure CkCgi_putIdleTimeoutMs(objHandle: HCkCgi; newPropVal: Integer); stdcall;

To be documented soon...

top
LastErrorHtml
procedure CkCgi_getLastErrorHtml(objHandle: HCkCgi; outPropVal: HCkString); stdcall;
function CkCgi__lastErrorHtml(objHandle: HCkCgi): 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 CkCgi_getLastErrorText(objHandle: HCkCgi; outPropVal: HCkString); stdcall;
function CkCgi__lastErrorText(objHandle: HCkCgi): 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 CkCgi_getLastErrorXml(objHandle: HCkCgi; outPropVal: HCkString); stdcall;
function CkCgi__lastErrorXml(objHandle: HCkCgi): 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 CkCgi_getLastMethodSuccess(objHandle: HCkCgi): wordbool; stdcall;
procedure CkCgi_putLastMethodSuccess(objHandle: HCkCgi; 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
NumParams
function CkCgi_getNumParams(objHandle: HCkCgi): Integer; stdcall;

To be documented soon...

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

To be documented soon...

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

To be documented soon...

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

To be documented soon...

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

To be documented soon...

top
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...

top
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.

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

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

top

Methods

AbortAsync
procedure CkCgi_AbortAsync(objHandle: HCkCgi) stdcall;

To be documented soon...

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

To be documented soon...

top
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.

top
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.

top
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.

top
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.

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

To be documented soon...

Returns True for success, False for failure.

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

To be documented soon...

Returns True for success, False for failure.

top
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.

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

To be documented soon...

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

To be documented soon...

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

To be documented soon...

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

To be documented soon...

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

To be documented soon...

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

To be documented soon...

top
SaveLastError
function CkCgi_SaveLastError(objHandle: HCkCgi;
    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
SaveNthToUploadDir
function CkCgi_SaveNthToUploadDir(objHandle: HCkCgi;
    index: Integer): wordbool; stdcall;

To be documented soon...

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

To be documented soon...

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

To be documented soon...

top