Cgi Tcl Reference Documentation
Cgi
Current Version: 9.5.0.98
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
set myCgi [new CkCgi]
Properties
AsyncBytesRead
set intVal [CkCgi_get_AsyncBytesRead $myCgi]
To be documented soon...
topAsyncInProgress
set boolVal [CkCgi_get_AsyncInProgress $myCgi]
To be documented soon...
topAsyncPostSize
set intVal [CkCgi_get_AsyncPostSize $myCgi]
To be documented soon...
topAsyncSuccess
set boolVal [CkCgi_get_AsyncSuccess $myCgi]
To be documented soon...
topDebugLogFilePath
# ckStr is a CkString
CkCgi_get_DebugLogFilePath $myCgi $ckStr
set strVal [CkCgi_get_debugLogFilePath $myCgi]
CkCgi_put_DebugLogFilePath $myCgi $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
set intVal [CkCgi_get_IdleTimeoutMs $myCgi]
CkCgi_put_IdleTimeoutMs $myCgi $intVal
To be documented soon...
topLastErrorHtml
# ckStr is a CkString
CkCgi_get_LastErrorHtml $myCgi $ckStr
set strVal [CkCgi_get_lastErrorHtml $myCgi]
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
CkCgi_get_LastErrorText $myCgi $ckStr
set strVal [CkCgi_get_lastErrorText $myCgi]
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
CkCgi_get_LastErrorXml $myCgi $ckStr
set strVal [CkCgi_get_lastErrorXml $myCgi]
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
set boolVal [CkCgi_get_LastMethodSuccess $myCgi]
CkCgi_put_LastMethodSuccess $myCgi $boolVal
Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
- 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.
topNumParams
set intVal [CkCgi_get_NumParams $myCgi]
To be documented soon...
topNumUploadFiles
set intVal [CkCgi_get_NumUploadFiles $myCgi]
To be documented soon...
topReadChunkSize
set intVal [CkCgi_get_ReadChunkSize $myCgi]
CkCgi_put_ReadChunkSize $myCgi $intVal
To be documented soon...
topSizeLimitKB
set intVal [CkCgi_get_SizeLimitKB $myCgi]
CkCgi_put_SizeLimitKB $myCgi $intVal
To be documented soon...
topStreamToUploadDir
set boolVal [CkCgi_get_StreamToUploadDir $myCgi]
CkCgi_put_StreamToUploadDir $myCgi $boolVal
To be documented soon...
topUploadDir
# ckStr is a CkString
CkCgi_get_UploadDir $myCgi $ckStr
set strVal [CkCgi_get_uploadDir $myCgi]
CkCgi_put_UploadDir $myCgi $strVal
To be documented soon...
topUtf8
set boolVal [CkCgi_get_Utf8 $myCgi]
CkCgi_put_Utf8 $myCgi $boolVal
When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.
topVerboseLogging
set boolVal [CkCgi_get_VerboseLogging $myCgi]
CkCgi_put_VerboseLogging $myCgi $boolVal
If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. 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)
set status [CkCgi_GetEnv $varName $outStr]
set retStr [CkCgi_getEnv $myCgi $varName]
GetParam
# outStr is a CkString (output)
set status [CkCgi_GetParam $paramName $outStr]
set retStr [CkCgi_getParam $myCgi $paramName]
GetParamName
# outStr is a CkString (output)
set status [CkCgi_GetParamName $index $outStr]
set retStr [CkCgi_getParamName $myCgi $index]
GetParamValue
# outStr is a CkString (output)
set status [CkCgi_GetParamValue $index $outStr]
set retStr [CkCgi_getParamValue $myCgi $index]
GetRawPostData
GetUploadData
# outData is a CkByteData (output)
set status [CkCgi_GetUploadData $index $outData]
GetUploadFilename
# outStr is a CkString (output)
set status [CkCgi_GetUploadFilename $index $outStr]
set retStr [CkCgi_getUploadFilename $myCgi $index]
GetUploadSize
set retInt [CkCgi_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
set retBool [CkCgi_SaveNthToUploadDir $index]
To be documented soon...
topSleepMs
CkCgi_SleepMs $millisec
To be documented soon...
topTestConsumeAspUpload
set retBool [CkCgi_TestConsumeAspUpload $path]
To be documented soon...
top