Cgi Unicode C Reference Documentation

Cgi

Current Version: 9.5.0.73

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

top
AsyncInProgress
BOOL CkCgiW_getAsyncInProgress(HCkCgiW cHandle);

To be documented soon...

top
AsyncPostSize
int CkCgiW_getAsyncPostSize(HCkCgiW cHandle);

To be documented soon...

top
AsyncSuccess
BOOL CkCgiW_getAsyncSuccess(HCkCgiW cHandle);

To be documented soon...

top
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, 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
HeartbeatMs
int CkCgiW_getHeartbeatMs(HCkCgiW cHandle);
void CkCgiW_putHeartbeatMs(HCkCgiW cHandle, int newVal);

To be documented soon...

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

To be documented soon...

top
LastErrorHtml
void CkCgiW_getLastErrorHtml(HCkCgiW cHandle, HCkString retval);
const wchar_t *CkCgiW_lastErrorHtml(HCkCgiW cHandle);

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
void CkCgiW_getLastErrorText(HCkCgiW cHandle, HCkString retval);
const wchar_t *CkCgiW_lastErrorText(HCkCgiW cHandle);

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
void CkCgiW_getLastErrorXml(HCkCgiW cHandle, HCkString retval);
const wchar_t *CkCgiW_lastErrorXml(HCkCgiW cHandle);

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
BOOL CkCgiW_getLastMethodSuccess(HCkCgiW cHandle);
void CkCgiW_putLastMethodSuccess(HCkCgiW cHandle, BOOL newVal);
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
int CkCgiW_getNumParams(HCkCgiW cHandle);

To be documented soon...

top
NumUploadFiles
int CkCgiW_getNumUploadFiles(HCkCgiW cHandle);

To be documented soon...

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

To be documented soon...

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

To be documented soon...

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

To be documented soon...

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

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

top
Version
void CkCgiW_getVersion(HCkCgiW cHandle, HCkString retval);
const wchar_t *CkCgiW_version(HCkCgiW cHandle);

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

top

Methods

AbortAsync
void CkCgiW_AbortAsync(HCkCgiW cHandle);

To be documented soon...

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

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

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

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

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

To be documented soon...

Returns TRUE for success, FALSE for failure.

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

To be documented soon...

Returns TRUE for success, FALSE for failure.

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

top
GetUploadSize
int CkCgiW_GetUploadSize(HCkCgiW cHandle, int index);

To be documented soon...

top
IsGet
BOOL CkCgiW_IsGet(HCkCgiW cHandle);

To be documented soon...

top
IsHead
BOOL CkCgiW_IsHead(HCkCgiW cHandle);

To be documented soon...

top
IsPost
BOOL CkCgiW_IsPost(HCkCgiW cHandle);

To be documented soon...

top
IsUpload
BOOL CkCgiW_IsUpload(HCkCgiW cHandle);

To be documented soon...

top
ReadRequest
BOOL CkCgiW_ReadRequest(HCkCgiW cHandle);

To be documented soon...

top
SaveLastError
BOOL CkCgiW_SaveLastError(HCkCgiW cHandle, const wchar_t *path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns TRUE for success, FALSE for failure.

top
SaveNthToUploadDir
BOOL CkCgiW_SaveNthToUploadDir(HCkCgiW cHandle, int index);

To be documented soon...

top
SleepMs
void CkCgiW_SleepMs(HCkCgiW cHandle, int millisec);

To be documented soon...

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

To be documented soon...

top