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

HCkCgiW instance = CkCgiW_Create();
// ...
CkCgiW_Dispose(instance);

HCkCgiW CkCgiW_Create(void);

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

void CkCgiW_Dispose(HCkCgiW handle);

Objects created by calling CkCgiW_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 CkCgiW_Dispose.

Properties

AsyncBytesRead

int CkCgiW_getAsyncBytesRead(HCkCgiW cHandle);

To be documented soon...

AsyncInProgress

BOOL CkCgiW_getAsyncInProgress(HCkCgiW cHandle);

To be documented soon...

AsyncPostSize

int CkCgiW_getAsyncPostSize(HCkCgiW cHandle);

To be documented soon...

AsyncSuccess

BOOL CkCgiW_getAsyncSuccess(HCkCgiW cHandle);

To be documented soon...

DebugLogFilePath

void CkCgiW_getDebugLogFilePath(HCkCgiW cHandle, HCkString retval);
void CkCgiW_putDebugLogFilePath(HCkCgiW cHandle, const wchar_t *newVal);
const wchar_t *CkCgiW_debugLogFilePath(HCkCgiW 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 CkCgiW_getHeartbeatMs(HCkCgiW cHandle);
void CkCgiW_putHeartbeatMs(HCkCgiW cHandle, int newVal);

To be documented soon...

IdleTimeoutMs

int CkCgiW_getIdleTimeoutMs(HCkCgiW cHandle);
void CkCgiW_putIdleTimeoutMs(HCkCgiW cHandle, int newVal);

To be documented soon...

LastErrorHtml

void CkCgiW_getLastErrorHtml(HCkCgiW cHandle, HCkString retval);
const wchar_t *CkCgiW_lastErrorHtml(HCkCgiW 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 CkCgiW_getLastErrorText(HCkCgiW cHandle, HCkString retval);
const wchar_t *CkCgiW_lastErrorText(HCkCgiW 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 CkCgiW_getLastErrorXml(HCkCgiW cHandle, HCkString retval);
const wchar_t *CkCgiW_lastErrorXml(HCkCgiW 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 CkCgiW_getLastMethodSuccess(HCkCgiW cHandle);
void CkCgiW_putLastMethodSuccess(HCkCgiW 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 CkCgiW_getNumParams(HCkCgiW cHandle);

To be documented soon...

NumUploadFiles

int CkCgiW_getNumUploadFiles(HCkCgiW cHandle);

To be documented soon...

ReadChunkSize

int CkCgiW_getReadChunkSize(HCkCgiW cHandle);
void CkCgiW_putReadChunkSize(HCkCgiW cHandle, int newVal);

To be documented soon...

SizeLimitKB

int CkCgiW_getSizeLimitKB(HCkCgiW cHandle);
void CkCgiW_putSizeLimitKB(HCkCgiW cHandle, int newVal);

To be documented soon...

StreamToUploadDir

BOOL CkCgiW_getStreamToUploadDir(HCkCgiW cHandle);
void CkCgiW_putStreamToUploadDir(HCkCgiW cHandle, BOOL newVal);

To be documented soon...

UploadDir

void CkCgiW_getUploadDir(HCkCgiW cHandle, HCkString retval);
void CkCgiW_putUploadDir(HCkCgiW cHandle, const wchar_t *newVal);
const wchar_t *CkCgiW_uploadDir(HCkCgiW cHandle);

To be documented soon...

VerboseLogging

BOOL CkCgiW_getVerboseLogging(HCkCgiW cHandle);
void CkCgiW_putVerboseLogging(HCkCgiW 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 CkCgiW_getVersion(HCkCgiW cHandle, HCkString retval);
const wchar_t *CkCgiW_version(HCkCgiW 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 CkCgiW_AbortAsync(HCkCgiW cHandle);

To be documented soon...

GetEnv

BOOL CkCgiW_GetEnv(HCkCgiW cHandle, const wchar_t *varName, const wchar_t *outStr);
const wchar_t *CkCgiW_getEnv(HCkCgiW cHandle, const wchar_t *varName);

To be documented soon...

Returns TRUE for success, FALSE for failure.

GetParam

BOOL CkCgiW_GetParam(HCkCgiW cHandle, const wchar_t *paramName, const wchar_t *outStr);
const wchar_t *CkCgiW_getParam(HCkCgiW cHandle, const wchar_t *paramName);

To be documented soon...

Returns TRUE for success, FALSE for failure.

GetParamName

BOOL CkCgiW_GetParamName(HCkCgiW cHandle, int index, const wchar_t *outStr);
const wchar_t *CkCgiW_getParamName(HCkCgiW cHandle, int index);

To be documented soon...

Returns TRUE for success, FALSE for failure.

GetParamValue

BOOL CkCgiW_GetParamValue(HCkCgiW cHandle, int index, const wchar_t *outStr);
const wchar_t *CkCgiW_getParamValue(HCkCgiW cHandle, int index);

To be documented soon...

Returns TRUE for success, FALSE for failure.

GetRawPostData

BOOL CkCgiW_GetRawPostData(HCkCgiW cHandle, const unsigned char * outData);

To be documented soon...

Returns TRUE for success, FALSE for failure.

GetUploadData

BOOL CkCgiW_GetUploadData(HCkCgiW cHandle, int index, const unsigned char * outData);

To be documented soon...

Returns TRUE for success, FALSE for failure.

GetUploadFilename

BOOL CkCgiW_GetUploadFilename(HCkCgiW cHandle, int index, const wchar_t *outStr);
const wchar_t *CkCgiW_getUploadFilename(HCkCgiW cHandle, int index);

To be documented soon...

Returns TRUE for success, FALSE for failure.

GetUploadSize

int CkCgiW_GetUploadSize(HCkCgiW cHandle, int index);

To be documented soon...

IsGet

BOOL CkCgiW_IsGet(HCkCgiW cHandle);

To be documented soon...

IsHead

BOOL CkCgiW_IsHead(HCkCgiW cHandle);

To be documented soon...

IsPost

BOOL CkCgiW_IsPost(HCkCgiW cHandle);

To be documented soon...

IsUpload

BOOL CkCgiW_IsUpload(HCkCgiW cHandle);

To be documented soon...

ReadRequest

BOOL CkCgiW_ReadRequest(HCkCgiW cHandle);

To be documented soon...

SaveNthToUploadDir

BOOL CkCgiW_SaveNthToUploadDir(HCkCgiW cHandle, int index);

To be documented soon...

SleepMs

void CkCgiW_SleepMs(HCkCgiW cHandle, int millisec);

To be documented soon...

TestConsumeAspUpload

BOOL CkCgiW_TestConsumeAspUpload(HCkCgiW cHandle, const wchar_t *path);

To be documented soon...