CkCgi Python Reference Documentation
CkCgi
Current Version: 9.5.0.97
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
obj = chilkat.CkCgi()
Properties
AsyncBytesRead
intVal = cgi.get_AsyncBytesRead();
To be documented soon...
topAsyncInProgress
boolVal = cgi.get_AsyncInProgress();
To be documented soon...
topAsyncPostSize
intVal = cgi.get_AsyncPostSize();
To be documented soon...
topAsyncSuccess
boolVal = cgi.get_AsyncSuccess();
To be documented soon...
topDebugLogFilePath
# ckStr is a CkString
cgi.get_DebugLogFilePath(ckStr);
strVal = cgi.debugLogFilePath();
cgi.put_DebugLogFilePath(strVal);
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:
- a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
- the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
- there is an internal problem (bug) in the Chilkat code that causes the hang.
IdleTimeoutMs
intVal = cgi.get_IdleTimeoutMs();
cgi.put_IdleTimeoutMs(intVal);
To be documented soon...
topLastErrorHtml
# ckStr is a CkString
cgi.get_LastErrorHtml(ckStr);
strVal = cgi.lastErrorHtml();
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.
topLastErrorText
# ckStr is a CkString
cgi.get_LastErrorText(ckStr);
strVal = cgi.lastErrorText();
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.
LastErrorXml
# ckStr is a CkString
cgi.get_LastErrorXml(ckStr);
strVal = cgi.lastErrorXml();
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.
topLastMethodSuccess
boolVal = cgi.get_LastMethodSuccess();
cgi.put_LastMethodSuccess(boolVal);
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.
topNumParams
intVal = cgi.get_NumParams();
To be documented soon...
topNumUploadFiles
intVal = cgi.get_NumUploadFiles();
To be documented soon...
topReadChunkSize
intVal = cgi.get_ReadChunkSize();
cgi.put_ReadChunkSize(intVal);
To be documented soon...
topSizeLimitKB
intVal = cgi.get_SizeLimitKB();
cgi.put_SizeLimitKB(intVal);
To be documented soon...
topStreamToUploadDir
boolVal = cgi.get_StreamToUploadDir();
cgi.put_StreamToUploadDir(boolVal);
To be documented soon...
topUploadDir
# ckStr is a CkString
cgi.get_UploadDir(ckStr);
strVal = cgi.uploadDir();
cgi.put_UploadDir(strVal);
To be documented soon...
topUtf8
boolVal = cgi.get_Utf8();
cgi.put_Utf8(boolVal);
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.
topVerboseLogging
boolVal = cgi.get_VerboseLogging();
cgi.put_VerboseLogging(boolVal);
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.
topVersion
Methods
AbortAsync
To be documented soon...
topAsyncReadRequest
To be documented soon...
topGetEnv
# outStr is a CkString (output)
status = cgi.GetEnv(varName, outStr);
retStr = cgi.getEnv(varName);
GetParam
# outStr is a CkString (output)
status = cgi.GetParam(paramName, outStr);
retStr = cgi.getParam(paramName);
GetParamName
# outStr is a CkString (output)
status = cgi.GetParamName(index, outStr);
retStr = cgi.getParamName(index);
GetParamValue
# outStr is a CkString (output)
status = cgi.GetParamValue(index, outStr);
retStr = cgi.getParamValue(index);
GetRawPostData
GetUploadData
# outData is a CkByteData (output)
status = cgi.GetUploadData(index, outData);
GetUploadFilename
# outStr is a CkString (output)
status = cgi.GetUploadFilename(index, outStr);
retStr = cgi.getUploadFilename(index);
GetUploadSize
retInt = cgi.GetUploadSize(index);
To be documented soon...
topIsGet
To be documented soon...
topIsHead
To be documented soon...
topIsPost
To be documented soon...
topIsUpload
To be documented soon...
topReadRequest
To be documented soon...
topSaveNthToUploadDir
retBool = cgi.SaveNthToUploadDir(index);
To be documented soon...
topSleepMs
cgi.SleepMs(millisec);
To be documented soon...
topTestConsumeAspUpload
retBool = cgi.TestConsumeAspUpload(path);
To be documented soon...
top