Cgi C++ Reference Documentation

CkCgi

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.

Object Creation

// Local variable on the stack
CkCgi obj;

// Dynamically allocate/delete
CkCgi *pObj = new CkCgi();
// ...
delete pObj;

Properties

AsyncBytesRead

int get_AsyncBytesRead(void);

To be documented soon...

AsyncInProgress

bool get_AsyncInProgress(void);

To be documented soon...

AsyncPostSize

int get_AsyncPostSize(void);

To be documented soon...

AsyncSuccess

bool get_AsyncSuccess(void);

To be documented soon...

DebugLogFilePath

void get_DebugLogFilePath(CkString &str);
const char *debugLogFilePath(void);
void put_DebugLogFilePath(const char *ansiOrUtf8Str);

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 get_HeartbeatMs(void);
void put_HeartbeatMs(int newVal);

To be documented soon...

IdleTimeoutMs

int get_IdleTimeoutMs(void);
void put_IdleTimeoutMs(int newVal);

To be documented soon...

LastErrorHtml

void get_LastErrorHtml(CkString &str);
const char *lastErrorHtml(void);

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 get_LastErrorText(CkString &str);
const char *lastErrorText(void);

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 get_LastErrorXml(CkString &str);
const char *lastErrorXml(void);

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 get_LastMethodSuccess(void);
void put_LastMethodSuccess(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 get_NumParams(void);

To be documented soon...

NumUploadFiles

int get_NumUploadFiles(void);

To be documented soon...

ReadChunkSize

int get_ReadChunkSize(void);
void put_ReadChunkSize(int newVal);

To be documented soon...

SizeLimitKB

int get_SizeLimitKB(void);
void put_SizeLimitKB(int newVal);

To be documented soon...

StreamToUploadDir

bool get_StreamToUploadDir(void);
void put_StreamToUploadDir(bool newVal);

To be documented soon...

UploadDir

void get_UploadDir(CkString &str);
const char *uploadDir(void);
void put_UploadDir(const char *ansiOrUtf8Str);

To be documented soon...

Utf8

bool get_Utf8(void);
void put_Utf8(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 get_VerboseLogging(void);
void put_VerboseLogging(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 get_Version(CkString &str);
const char *version(void);

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 AbortAsync(void);

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.

AsyncReadRequest

bool AsyncReadRequest(void);

To be documented soon...

GetEnv

bool GetEnv(const char *varName, CkString &outStr);
const char *getEnv(const char *varName);

To be documented soon...

Returns true for success, false for failure.

GetParam

bool GetParam(const char *paramName, CkString &outStr);
const char *getParam(const char *paramName);

To be documented soon...

Returns true for success, false for failure.

GetParamName

bool GetParamName(int index, CkString &outStr);
const char *getParamName(int index);

To be documented soon...

Returns true for success, false for failure.

GetParamValue

bool GetParamValue(int index, CkString &outStr);
const char *getParamValue(int index);

To be documented soon...

Returns true for success, false for failure.

GetRawPostData

bool GetRawPostData(CkByteData &outData);

To be documented soon...

Returns true for success, false for failure.

GetUploadData

bool GetUploadData(int index, CkByteData &outData);

To be documented soon...

Returns true for success, false for failure.

GetUploadFilename

bool GetUploadFilename(int index, CkString &outStr);
const char *getUploadFilename(int index);

To be documented soon...

Returns true for success, false for failure.

GetUploadSize

int GetUploadSize(int index);

To be documented soon...

IsGet

bool IsGet(void);

To be documented soon...

IsHead

bool IsHead(void);

To be documented soon...

IsPost

bool IsPost(void);

To be documented soon...

IsUpload

bool IsUpload(void);

To be documented soon...

ReadRequest

bool ReadRequest(void);

To be documented soon...

SaveNthToUploadDir

bool SaveNthToUploadDir(int index);

To be documented soon...

SleepMs

void SleepMs(int millisec);

To be documented soon...

TestConsumeAspUpload

bool TestConsumeAspUpload(const char *path);

To be documented soon...