Cgi C 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

HCkCgi instance = CkCgi_Create();
// ...
CkCgi_Dispose(instance);

HCkCgi CkCgi_Create(void);

Creates an instance of the HCkCgi object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkCgi_Dispose(HCkCgi handle);

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. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkCgi_Dispose.

Properties

AsyncBytesRead

int CkCgi_getAsyncBytesRead(HCkCgi cHandle);

To be documented soon...

AsyncInProgress

BOOL CkCgi_getAsyncInProgress(HCkCgi cHandle);

To be documented soon...

AsyncPostSize

int CkCgi_getAsyncPostSize(HCkCgi cHandle);

To be documented soon...

AsyncSuccess

BOOL CkCgi_getAsyncSuccess(HCkCgi cHandle);

To be documented soon...

DebugLogFilePath

void CkCgi_getDebugLogFilePath(HCkCgi cHandle, HCkString retval);
void CkCgi_putDebugLogFilePath(HCkCgi cHandle, const char *newVal);
const char *CkCgi_debugLogFilePath(HCkCgi cHandle);

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.

More Information and Examples

Example showing how to use DebugLogFilePath.

HeartbeatMs

int CkCgi_getHeartbeatMs(HCkCgi cHandle);
void CkCgi_putHeartbeatMs(HCkCgi cHandle, int newVal);

To be documented soon...

IdleTimeoutMs

int CkCgi_getIdleTimeoutMs(HCkCgi cHandle);
void CkCgi_putIdleTimeoutMs(HCkCgi cHandle, int newVal);

To be documented soon...

LastErrorHtml

void CkCgi_getLastErrorHtml(HCkCgi cHandle, HCkString retval);
const char *CkCgi_lastErrorHtml(HCkCgi cHandle);

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.

LastErrorText

void CkCgi_getLastErrorText(HCkCgi cHandle, HCkString retval);
const char *CkCgi_lastErrorText(HCkCgi cHandle);

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.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

void CkCgi_getLastErrorXml(HCkCgi cHandle, HCkString retval);
const char *CkCgi_lastErrorXml(HCkCgi cHandle);

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.

LastMethodSuccess

BOOL CkCgi_getLastMethodSuccess(HCkCgi cHandle);
void CkCgi_putLastMethodSuccess(HCkCgi cHandle, BOOL newVal);

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

int CkCgi_getNumParams(HCkCgi cHandle);

To be documented soon...

NumUploadFiles

int CkCgi_getNumUploadFiles(HCkCgi cHandle);

To be documented soon...

ReadChunkSize

int CkCgi_getReadChunkSize(HCkCgi cHandle);
void CkCgi_putReadChunkSize(HCkCgi cHandle, int newVal);

To be documented soon...

SizeLimitKB

int CkCgi_getSizeLimitKB(HCkCgi cHandle);
void CkCgi_putSizeLimitKB(HCkCgi cHandle, int newVal);

To be documented soon...

StreamToUploadDir

BOOL CkCgi_getStreamToUploadDir(HCkCgi cHandle);
void CkCgi_putStreamToUploadDir(HCkCgi cHandle, BOOL newVal);

To be documented soon...

UploadDir

void CkCgi_getUploadDir(HCkCgi cHandle, HCkString retval);
void CkCgi_putUploadDir(HCkCgi cHandle, const char *newVal);
const char *CkCgi_uploadDir(HCkCgi cHandle);

To be documented soon...

Utf8

BOOL CkCgi_getUtf8(HCkCgi cHandle);
void CkCgi_putUtf8(HCkCgi cHandle, BOOL newVal);

When set to TRUE, all "const char *" arguments are interpreted as utf-8 strings. If set to FALSE (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to TRUE, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to FALSE, all "const char *" return values are ANSI strings.

VerboseLogging

BOOL CkCgi_getVerboseLogging(HCkCgi cHandle);
void CkCgi_putVerboseLogging(HCkCgi cHandle, BOOL newVal);

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

void CkCgi_getVersion(HCkCgi cHandle, HCkString retval);
const char *CkCgi_version(HCkCgi cHandle);

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AbortAsync

void CkCgi_AbortAsync(HCkCgi cHandle);

To be documented soon...

GetEnv

BOOL CkCgi_GetEnv(HCkCgi cHandle, const char *varName, HCkString outStr);
const char *CkCgi_getEnv(HCkCgi cHandle, const char *varName);

To be documented soon...

Returns TRUE for success, FALSE for failure.

GetParam

BOOL CkCgi_GetParam(HCkCgi cHandle, const char *paramName, HCkString outStr);
const char *CkCgi_getParam(HCkCgi cHandle, const char *paramName);

To be documented soon...

Returns TRUE for success, FALSE for failure.

GetParamName

BOOL CkCgi_GetParamName(HCkCgi cHandle, int index, HCkString outStr);
const char *CkCgi_getParamName(HCkCgi cHandle, int index);

To be documented soon...

Returns TRUE for success, FALSE for failure.

GetParamValue

BOOL CkCgi_GetParamValue(HCkCgi cHandle, int index, HCkString outStr);
const char *CkCgi_getParamValue(HCkCgi cHandle, int index);

To be documented soon...

Returns TRUE for success, FALSE for failure.

GetRawPostData

BOOL CkCgi_GetRawPostData(HCkCgi cHandle, HCkByteData outData);

To be documented soon...

Returns TRUE for success, FALSE for failure.

GetUploadData

BOOL CkCgi_GetUploadData(HCkCgi cHandle, int index, HCkByteData outData);

To be documented soon...

Returns TRUE for success, FALSE for failure.

GetUploadFilename

BOOL CkCgi_GetUploadFilename(HCkCgi cHandle, int index, HCkString outStr);
const char *CkCgi_getUploadFilename(HCkCgi cHandle, int index);

To be documented soon...

Returns TRUE for success, FALSE for failure.

GetUploadSize

int CkCgi_GetUploadSize(HCkCgi cHandle, int index);

To be documented soon...

IsGet

BOOL CkCgi_IsGet(HCkCgi cHandle);

To be documented soon...

IsHead

BOOL CkCgi_IsHead(HCkCgi cHandle);

To be documented soon...

IsPost

BOOL CkCgi_IsPost(HCkCgi cHandle);

To be documented soon...

IsUpload

BOOL CkCgi_IsUpload(HCkCgi cHandle);

To be documented soon...

ReadRequest

BOOL CkCgi_ReadRequest(HCkCgi cHandle);

To be documented soon...

SaveNthToUploadDir

BOOL CkCgi_SaveNthToUploadDir(HCkCgi cHandle, int index);

To be documented soon...

SleepMs

void CkCgi_SleepMs(HCkCgi cHandle, int millisec);

To be documented soon...

TestConsumeAspUpload

BOOL CkCgi_TestConsumeAspUpload(HCkCgi cHandle, const char *path);

To be documented soon...