Cgi Delphi DLL Reference Documentation
Cgi
Current Version: 9.5.0.97
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;
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.
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
To be documented soon...
topAsyncInProgress
To be documented soon...
topAsyncPostSize
To be documented soon...
topAsyncSuccess
To be documented soon...
topDebugLogFilePath
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:
- 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.
HeartbeatMs
procedure CkCgi_putHeartbeatMs(objHandle: HCkCgi; newPropVal: Integer); stdcall;
To be documented soon...
topIdleTimeoutMs
procedure CkCgi_putIdleTimeoutMs(objHandle: HCkCgi; newPropVal: Integer); stdcall;
To be documented soon...
topLastErrorHtml
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.
topLastErrorText
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.
LastErrorXml
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.
topLastMethodSuccess
procedure CkCgi_putLastMethodSuccess(objHandle: HCkCgi; newPropVal: wordbool); stdcall;
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.
topNumParams
To be documented soon...
topNumUploadFiles
To be documented soon...
topReadChunkSize
procedure CkCgi_putReadChunkSize(objHandle: HCkCgi; newPropVal: Integer); stdcall;
To be documented soon...
topSizeLimitKB
procedure CkCgi_putSizeLimitKB(objHandle: HCkCgi; newPropVal: Integer); stdcall;
To be documented soon...
topStreamToUploadDir
procedure CkCgi_putStreamToUploadDir(objHandle: HCkCgi; newPropVal: wordbool); stdcall;
To be documented soon...
topUploadDir
procedure CkCgi_putUploadDir(objHandle: HCkCgi; newPropVal: PWideChar); stdcall;
function CkCgi__uploadDir(objHandle: HCkCgi): PWideChar; stdcall;
To be documented soon...
topVerboseLogging
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.
topVersion
function CkCgi__version(objHandle: HCkCgi): PWideChar; stdcall;
Methods
AbortAsync
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.
topAsyncReadRequest
To be documented soon...
topGetEnv
varName: PWideChar;
outStr: HCkString): wordbool; stdcall;
function CkCgi__getEnv(objHandle: HCkCgi;
varName: PWideChar): PWideChar; stdcall;
GetParam
paramName: PWideChar;
outStr: HCkString): wordbool; stdcall;
function CkCgi__getParam(objHandle: HCkCgi;
paramName: PWideChar): PWideChar; stdcall;
GetParamName
index: Integer;
outStr: HCkString): wordbool; stdcall;
function CkCgi__getParamName(objHandle: HCkCgi;
index: Integer): PWideChar; stdcall;
GetParamValue
index: Integer;
outStr: HCkString): wordbool; stdcall;
function CkCgi__getParamValue(objHandle: HCkCgi;
index: Integer): PWideChar; stdcall;
GetRawPostData
GetUploadData
index: Integer;
outData: HCkByteData): wordbool; stdcall;
GetUploadFilename
index: Integer;
outStr: HCkString): wordbool; stdcall;
function CkCgi__getUploadFilename(objHandle: HCkCgi;
index: Integer): PWideChar; stdcall;
GetUploadSize
index: Integer): Integer; stdcall;
To be documented soon...
topIsGet
To be documented soon...
topIsHead
To be documented soon...
topIsPost
To be documented soon...
topIsUpload
To be documented soon...
topReadRequest
To be documented soon...
topSaveNthToUploadDir
index: Integer): wordbool; stdcall;
To be documented soon...
topSleepMs
millisec: Integer) stdcall;
To be documented soon...
topTestConsumeAspUpload
path: PWideChar): wordbool; stdcall;
To be documented soon...
top