Cgi 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

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

top
AsyncInProgress
BOOL CkCgi_getAsyncInProgress(HCkCgi cHandle);

To be documented soon...

top
AsyncPostSize
int CkCgi_getAsyncPostSize(HCkCgi cHandle);

To be documented soon...

top
AsyncSuccess
BOOL CkCgi_getAsyncSuccess(HCkCgi cHandle);

To be documented soon...

top
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, 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 CkCgi_getHeartbeatMs(HCkCgi cHandle);
void CkCgi_putHeartbeatMs(HCkCgi cHandle, int newVal);

To be documented soon...

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

To be documented soon...

top
LastErrorHtml
void CkCgi_getLastErrorHtml(HCkCgi cHandle, HCkString retval);
const char *CkCgi_lastErrorHtml(HCkCgi 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 CkCgi_getLastErrorText(HCkCgi cHandle, HCkString retval);
const char *CkCgi_lastErrorText(HCkCgi 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 CkCgi_getLastErrorXml(HCkCgi cHandle, HCkString retval);
const char *CkCgi_lastErrorXml(HCkCgi 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 CkCgi_getLastMethodSuccess(HCkCgi cHandle);
void CkCgi_putLastMethodSuccess(HCkCgi 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 CkCgi_getNumParams(HCkCgi cHandle);

To be documented soon...

top
NumUploadFiles
int CkCgi_getNumUploadFiles(HCkCgi cHandle);

To be documented soon...

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

To be documented soon...

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

To be documented soon...

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

To be documented soon...

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

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

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

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

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

top

Methods

AbortAsync
void CkCgi_AbortAsync(HCkCgi cHandle);

To be documented soon...

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

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

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

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

top
GetRawPostData
BOOL CkCgi_GetRawPostData(HCkCgi cHandle, HCkByteData outData);

To be documented soon...

Returns TRUE for success, FALSE for failure.

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

To be documented soon...

Returns TRUE for success, FALSE for failure.

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

top
GetUploadSize
int CkCgi_GetUploadSize(HCkCgi cHandle, int index);

To be documented soon...

top
IsGet
BOOL CkCgi_IsGet(HCkCgi cHandle);

To be documented soon...

top
IsHead
BOOL CkCgi_IsHead(HCkCgi cHandle);

To be documented soon...

top
IsPost
BOOL CkCgi_IsPost(HCkCgi cHandle);

To be documented soon...

top
IsUpload
BOOL CkCgi_IsUpload(HCkCgi cHandle);

To be documented soon...

top
ReadRequest
BOOL CkCgi_ReadRequest(HCkCgi cHandle);

To be documented soon...

top
SaveLastError
BOOL CkCgi_SaveLastError(HCkCgi cHandle, const char *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 CkCgi_SaveNthToUploadDir(HCkCgi cHandle, int index);

To be documented soon...

top
SleepMs
void CkCgi_SleepMs(HCkCgi cHandle, int millisec);

To be documented soon...

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

To be documented soon...

top