Cgi Perl 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

$obj = chilkat::CkCgi->new();

Properties

AsyncBytesRead

# $intVal is an integer
$intVal = $cgi->get_AsyncBytesRead();

To be documented soon...

AsyncInProgress

# $boolVal is a boolean
$boolVal = $cgi->get_AsyncInProgress();

To be documented soon...

AsyncPostSize

# $intVal is an integer
$intVal = $cgi->get_AsyncPostSize();

To be documented soon...

AsyncSuccess

# $boolVal is a boolean
$boolVal = $cgi->get_AsyncSuccess();

To be documented soon...

DebugLogFilePath

# $strVal is a string
# $ckStr is a CkString
$cgi->get_DebugLogFilePath($ckStr);
$strVal = $cgi->debugLogFilePath();
$cgi->put_DebugLogFilePath($strVal);

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.

IdleTimeoutMs

# $intVal is an integer
$intVal = $cgi->get_IdleTimeoutMs();
$cgi->put_IdleTimeoutMs($intVal);

To be documented soon...

LastErrorHtml

# $strVal is a string
# $ckStr is a CkString
$cgi->get_LastErrorHtml($ckStr);
$strVal = $cgi->lastErrorHtml();

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

# $strVal is a string
# $ckStr is a CkString
$cgi->get_LastErrorText($ckStr);
$strVal = $cgi->lastErrorText();

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

# $strVal is a string
# $ckStr is a CkString
$cgi->get_LastErrorXml($ckStr);
$strVal = $cgi->lastErrorXml();

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

# $boolVal is a boolean
$boolVal = $cgi->get_LastMethodSuccess();
$cgi->put_LastMethodSuccess($boolVal);

Indicates the success or failure of the most recent method call: 1 means success, 0 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

# $intVal is an integer
$intVal = $cgi->get_NumParams();

To be documented soon...

NumUploadFiles

# $intVal is an integer
$intVal = $cgi->get_NumUploadFiles();

To be documented soon...

ReadChunkSize

# $intVal is an integer
$intVal = $cgi->get_ReadChunkSize();
$cgi->put_ReadChunkSize($intVal);

To be documented soon...

SizeLimitKB

# $intVal is an integer
$intVal = $cgi->get_SizeLimitKB();
$cgi->put_SizeLimitKB($intVal);

To be documented soon...

StreamToUploadDir

# $boolVal is a boolean
$boolVal = $cgi->get_StreamToUploadDir();
$cgi->put_StreamToUploadDir($boolVal);

To be documented soon...

UploadDir

# $strVal is a string
# $ckStr is a CkString
$cgi->get_UploadDir($ckStr);
$strVal = $cgi->uploadDir();
$cgi->put_UploadDir($strVal);

To be documented soon...

Utf8

# $boolVal is a boolean
$boolVal = $cgi->get_Utf8();
$cgi->put_Utf8($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.

VerboseLogging

# $boolVal is a boolean
$boolVal = $cgi->get_VerboseLogging();
$cgi->put_VerboseLogging($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.

Version

# $strVal is a string
# $ckStr is a CkString
$cgi->get_Version($ckStr);
$strVal = $cgi->version();

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AbortAsync

$cgi->AbortAsync();

To be documented soon...

AsyncReadRequest

$retBool = $cgi->AsyncReadRequest();

To be documented soon...

GetEnv

# $varName is a string
# $outStr is a CkString (output)
$status = $cgi->GetEnv($varName, $outStr);
$retStr = $cgi->getEnv($varName);

To be documented soon...

Returns 1 for success, 0 for failure.

GetParam

# $paramName is a string
# $outStr is a CkString (output)
$status = $cgi->GetParam($paramName, $outStr);
$retStr = $cgi->getParam($paramName);

To be documented soon...

Returns 1 for success, 0 for failure.

GetParamName

# $index is an integer
# $outStr is a CkString (output)
$status = $cgi->GetParamName($index, $outStr);
$retStr = $cgi->getParamName($index);

To be documented soon...

Returns 1 for success, 0 for failure.

GetParamValue

# $index is an integer
# $outStr is a CkString (output)
$status = $cgi->GetParamValue($index, $outStr);
$retStr = $cgi->getParamValue($index);

To be documented soon...

Returns 1 for success, 0 for failure.

GetRawPostData

# $outData is a CkByteData (output)
$status = $cgi->GetRawPostData($outData);

To be documented soon...

Returns 1 for success, 0 for failure.

GetUploadData

# $index is an integer
# $outData is a CkByteData (output)
$status = $cgi->GetUploadData($index, $outData);

To be documented soon...

Returns 1 for success, 0 for failure.

GetUploadFilename

# $index is an integer
# $outStr is a CkString (output)
$status = $cgi->GetUploadFilename($index, $outStr);
$retStr = $cgi->getUploadFilename($index);

To be documented soon...

Returns 1 for success, 0 for failure.

GetUploadSize

# $index is an integer
$retInt = $cgi->GetUploadSize($index);

To be documented soon...

IsGet

$retBool = $cgi->IsGet();

To be documented soon...

IsHead

$retBool = $cgi->IsHead();

To be documented soon...

IsPost

$retBool = $cgi->IsPost();

To be documented soon...

IsUpload

$retBool = $cgi->IsUpload();

To be documented soon...

ReadRequest

$retBool = $cgi->ReadRequest();

To be documented soon...

SaveNthToUploadDir

# $index is an integer
$retBool = $cgi->SaveNthToUploadDir($index);

To be documented soon...

SleepMs

# $millisec is an integer
$cgi->SleepMs($millisec);

To be documented soon...

TestConsumeAspUpload

# $path is a string
$retBool = $cgi->TestConsumeAspUpload($path);

To be documented soon...