CkCgiW Unicode C++ Reference Documentation

CkCgiW

Current Version: 9.5.0.75

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
CkCgiW obj;

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

Properties

AsyncBytesRead
int get_AsyncBytesRead(void);

To be documented soon...

top
AsyncInProgress
bool get_AsyncInProgress(void);

To be documented soon...

top
AsyncPostSize
int get_AsyncPostSize(void);

To be documented soon...

top
AsyncSuccess
bool get_AsyncSuccess(void);

To be documented soon...

top
DebugLogFilePath
void get_DebugLogFilePath(CkString &str);
const wchar_t *debugLogFilePath(void);
void put_DebugLogFilePath(const wchar_t *str);

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

To be documented soon...

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

To be documented soon...

top
LastErrorHtml
void get_LastErrorHtml(CkString &str);
const wchar_t *lastErrorHtml(void);

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

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

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

To be documented soon...

top
NumUploadFiles
int get_NumUploadFiles(void);

To be documented soon...

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

To be documented soon...

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

To be documented soon...

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

To be documented soon...

top
UploadDir
void get_UploadDir(CkString &str);
const wchar_t *uploadDir(void);
void put_UploadDir(const wchar_t *str);

To be documented soon...

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

top
Version
void get_Version(CkString &str);
const wchar_t *version(void);

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

top

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.

top
AsyncReadRequest
bool AsyncReadRequest(void);

To be documented soon...

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

To be documented soon...

Returns true for success, false for failure.

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

To be documented soon...

Returns true for success, false for failure.

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

To be documented soon...

Returns true for success, false for failure.

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

To be documented soon...

Returns true for success, false for failure.

top
GetRawPostData
bool GetRawPostData(CkByteData &outData);
const wchar_t *getRawPostData(void);

To be documented soon...

Returns true for success, false for failure.

top
GetUploadData
bool GetUploadData(int index, CkByteData &outData);
const wchar_t *getUploadData(int index);

To be documented soon...

Returns true for success, false for failure.

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

To be documented soon...

Returns true for success, false for failure.

top
GetUploadSize
int GetUploadSize(int index);

To be documented soon...

top
IsGet
bool IsGet(void);

To be documented soon...

top
IsHead
bool IsHead(void);

To be documented soon...

top
IsPost
bool IsPost(void);

To be documented soon...

top
IsUpload
bool IsUpload(void);

To be documented soon...

top
ReadRequest
bool ReadRequest(void);

To be documented soon...

top
SaveLastError
bool SaveLastError(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 SaveNthToUploadDir(int index);

To be documented soon...

top
SleepMs
void SleepMs(int millisec);

To be documented soon...

top
TestConsumeAspUpload
bool TestConsumeAspUpload(const wchar_t *path);

To be documented soon...

top