BinData Perl Reference Documentation
CkBinData
Current Version: 11.0.0
Container for binary data. Provides methods for getting, setting, appending, etc. in binary and string encoded formats.
Object Creation
$obj = chilkat::CkBinData->new();
Properties
DebugLogFilePath
# $ckStr is a CkString
$binData->get_DebugLogFilePath($ckStr);
$strVal = $binData->debugLogFilePath();
$binData->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.
LastErrorHtml
# $ckStr is a CkString
$binData->get_LastErrorHtml($ckStr);
$strVal = $binData->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.
topLastErrorText
# $ckStr is a CkString
$binData->get_LastErrorText($ckStr);
$strVal = $binData->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.
LastErrorXml
# $ckStr is a CkString
$binData->get_LastErrorXml($ckStr);
$strVal = $binData->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.
topLastMethodSuccess
$boolVal = $binData->get_LastMethodSuccess();
$binData->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.
NumBytes
$intVal = $binData->get_NumBytes();
The number of bytes contained within the object.
topVerboseLogging
$boolVal = $binData->get_VerboseLogging();
$binData->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
# $ckStr is a CkString
$binData->get_Version($ckStr);
$strVal = $binData->version();
Methods
AppendBd
$status = $binData->AppendBd($binData);
AppendBinary Deprecated
AppendBom
$status = $binData->AppendBom($charset);
Appends the appropriate BOM (byte order mark), also known as a "preamble", for the given charset. If the charset has no defined BOM, then nothing is appended. An application would typically call this to append the utf-8, utf-16, or utf-32 BOM.
Returns 1 for success, 0 for failure.
AppendByte
$status = $binData->AppendByte($byteValue);
Appends a single byte. The byteValue should be a value from 0 to 255.
Returns 1 for success, 0 for failure.
topAppendCountedString
# $bigEndian is a boolean
# $str is a string
# $charset is a string
$status = $binData->AppendCountedString($numCountBytes, $bigEndian, $str, $charset);
Appends a byte count followed by the string in the desired character encoding, such as "utf-8". The numCountBytes is the size in bytes of the integer to represent the byte count. If 0, then a minimal number of bytes is used. If bigEndian is 1, the byte count is appended in big endian byte ordering, otherwise little-ending byte ordering. The str is the string to be appended. The charset is the character encoding, such as "utf-8", "utf-16", "windows-1252", etc.
Returns 1 for success, 0 for failure.
topAppendData Deprecated
# $numBytes is an integer
$status = $binData->AppendData($data, $numBytes);
Appends binary data to the current contents.
Returns 1 for success, 0 for failure.
AppendEncoded
# $encoding is a string
$status = $binData->AppendEncoded($encData, $encoding);
Appends encoded binary data to the current data. The encoding may be "Base64", "modBase64", "base64Url", "Base32", "Base58", "QP" (for quoted-printable), "URL" (for url-encoding), "Hex", or any of the encodings found at Chilkat Binary Encodings List.
Returns 1 for success, 0 for failure.
AppendEncodedSb
# $encoding is a string
$status = $binData->AppendEncodedSb($sb, $encoding);
Decodes the contents of sb and appends the decoded bytes to this object. The encoding may be "Base64", "modBase64", "base64Url", "Base32", "Base58", "QP" (for quoted-printable), "URL" (for url-encoding), "Hex", or any of the encodings found at Chilkat Binary Encodings List.
Returns 1 for success, 0 for failure.
AppendInt2
# $littleEndian is a boolean
$status = $binData->AppendInt2($value, $littleEndian);
Appends a 16-bit integer (2 bytes). If littleEndian is 1, then the integer bytes are appended in little-endian byte order, otherwise big-endian byte order is used.
Returns 1 for success, 0 for failure.
AppendInt4
# $littleEndian is a boolean
$status = $binData->AppendInt4($value, $littleEndian);
Appends a 32-bit integer (4 bytes). If littleEndian is 1, then the integer bytes are appended in little-endian byte order, otherwise big-endian byte order is used.
Returns 1 for success, 0 for failure.
AppendPadded
# $charset is a string
# $padWithSpace is a boolean
# $fieldLen is an integer
$status = $binData->AppendPadded($str, $charset, $padWithSpace, $fieldLen);
Appends a string to this object, padded to the fieldLen with NULL or SPACE chars. If padWithSpace is 1, then SPACE chars are used and the string is not null-terminated. If fieldLen is 0, then null bytes are used. The charset controls the byte representation to use, such as "utf-8".
Note: This call will always append a total number of bytes equal to fieldLen. If the str is longer than fieldLen, the method returns 0 to indicate failure and nothing is appended.
Returns 1 for success, 0 for failure.
AppendSb
Appends the contents of a StringBuilder to this object.
Returns 1 for success, 0 for failure.
AppendString
# $charset is a string
$status = $binData->AppendString($str, $charset);
Appends a string to this object. (This does not append the BOM. If a BOM is required, the AppendBom method can be called to append the appropriate BOM.)
Returns 1 for success, 0 for failure.
ByteSwap
$status = $binData->ByteSwap($size);
Does either 16-bit or 32-bit byte swapping of the entire contents. If size equals 16, then swaps in 2 bytes (e.g., 0x1234 → 0x3412). If size equals 32, then swaps 4 bytes (e.g., 0x12345678 → 0x78563412)
Returns 1 for success, 0 for failure.
topCharsetConvert
# $toCharset is a string
# $allOrNone is a boolean
$status = $binData->CharsetConvert($fromCharset, $toCharset, $allOrNone);
This method converts the character encoding of an object's contents from one format to another, such as from Windows-1252 to UTF-8. The allOrNone parameter determines error handling for unrepresentable bytes. If allOrNone is 1, the object's contents remain unchanged when errors occur. If 0, error bytes are discarded. The method returns 1 if successful and 0 if errors occur.
Returns 1 for success, 0 for failure.
topClear
ContentsEqual
$retBool = $binData->ContentsEqual($binData);
Return 1 if the contents of this object equals the contents of binData.
FindString
# $startIdx is an integer
# $charset is a string
$retInt = $binData->FindString($str, $startIdx, $charset);
Return the index where the first occurrence of str is found. Return -1 if not found. The startIdx indicates the byte index where the search begins. The charset specifies the byte representation of str that is to be searched. For example, it can be "utf-8", "windows-1252", "ansi", "utf-16", etc.
topGetBinary Deprecated
GetBinaryChunk Deprecated
# $numBytes is an integer
# $outBytes is a CkByteData (output)
$status = $binData->GetBinaryChunk($offset, $numBytes, $outData);
Retrieves a chunk of the binary data contained within the object.
Returns 1 for success, 0 for failure.
topGetByte
$status = $binData->GetByte($index);
Returns the value of the byte at the given index. The returned value is an integer from 0 to 255.
Returns 1 for success, 0 for failure.
topGetData Deprecated
Retrieves the binary data contained within the object.
Returns null on failure
GetDataChunk Deprecated
# $numBytes is an integer
$binaryString = $binData->GetDataChunk($offset, $numBytes);
Retrieves a chunk of the binary data contained within the object.
Returns null on failure
GetEncoded
# $outStr is a CkString (output)
$status = $binData->GetEncoded($encoding, $outStr);
$retStr = $binData->getEncoded($encoding);
Retrieves the binary data as an encoded string. The encoding may be "Base64", "modBase64", "base64Url", "Base32", "Base58", "QP" (for quoted-printable), "URL" (for url-encoding), "Hex", or any of the encodings found at Chilkat Binary Encodings List.
Returns 1 for success, 0 for failure.
GetEncodedChunk
# $numBytes is an integer
# $encoding is a string
# $outStr is a CkString (output)
$status = $binData->GetEncodedChunk($offset, $numBytes, $encoding, $outStr);
$retStr = $binData->getEncodedChunk($offset, $numBytes, $encoding);
Retrieves a chunk of the binary data and returns it in encoded form. The encoding may be "Base64", "modBase64", "base64Url", "Base32", "Base58", "QP" (for quoted-printable), "URL" (for url-encoding), "Hex", or any of the encodings found at Chilkat Binary Encodings List.
Returns 1 for success, 0 for failure.
GetEncodedSb
# $sb is a CkStringBuilder
$status = $binData->GetEncodedSb($encoding, $sb);
Writes the encoded data to a StringBuilder. The encoding may be "Base64", "modBase64", "base64Url", "Base32", "Base58", "QP" (for quoted-printable), "URL" (for url-encoding), "Hex", or any of the encodings found at Chilkat Binary Encodings List.
Returns 1 for success, 0 for failure.
GetHash
# $encoding is a string
# $outStr is a CkString (output)
$status = $binData->GetHash($algorithm, $encoding, $outStr);
$retStr = $binData->getHash($algorithm, $encoding);
Returns the hash of the contents of this object. The algorithm is the hash algorithm, and can be "sha1", "sha256", "sha384", "sha512", "sha3-224", "sha3-256", "sha3-384", "sha3-512", "md2", "md5", "ripemd128", "ripemd160","ripemd256", or "ripemd320". The encoding can be "base64", "modBase64", "base64Url", "base32", "base58", "qp" (for quoted-printable), "url" (for url-encoding), "hex", "hexLower", or any of the encodings found at Chilkat Binary Encodings List.
Returns 1 for success, 0 for failure.
topGetInt2
# $littleEndian is a boolean
$retInt = $binData->GetInt2($index, $littleEndian);
Returns the value of the 16-bit signed integer stored in big-endian or little-endian byte ordering at the given index.
topGetInt4
# $littleEndian is a boolean
$retInt = $binData->GetInt4($index, $littleEndian);
Returns the value of the 32-bit signed integer stored in big-endian or little-endian byte ordering at the given index.
topGetString
# $outStr is a CkString (output)
$status = $binData->GetString($charset, $outStr);
$retStr = $binData->getString($charset);
Interprets the bytes according to charset and returns the string. The charset can be "utf-8", "utf-16", "ansi", "iso-8859-*", "windows-125*", or any of the supported character encodings listed in the link below.
Returns 1 for success, 0 for failure.
GetTextChunk
# $numBytes is an integer
# $charset is a string
# $outStr is a CkString (output)
$status = $binData->GetTextChunk($startIdx, $numBytes, $charset, $outStr);
$retStr = $binData->getTextChunk($startIdx, $numBytes, $charset);
Returns numBytes bytes starting at startIdx. The bytes are interpreted according to charset (for example, "utf-8", "ansi", "utf-16", "windows-1252", etc.)
Returns 1 for success, 0 for failure.
topGetUInt2
# $littleEndian is a boolean
$retInt = $binData->GetUInt2($index, $littleEndian);
Returns the value of the 16-bit unsigned integer stored in big-endian or little-endian byte ordering at the given index.
topGetUInt4
# $littleEndian is a boolean
$retInt = $binData->GetUInt4($index, $littleEndian);
Returns the value of the 32-bit unsigned integer stored in big-endian or little-endian byte ordering at the given index.
topIsValidUtf8
Returns 1 if this object contains valid utf-8 byte sequences. Any invalid byte sequence that is not valid utf-8 will cause this function to return 0.
Returns 1 for success, 0 for failure.
topLoadBinary Deprecated
Loads binary data and replaces the current contents, if any.
Returns 1 for success, 0 for failure.
topLoadEncoded
# $encoding is a string
$status = $binData->LoadEncoded($encData, $encoding);
Loads binary data from an encoded string, replacing the current contents, if any. The encoding may be "Base64", "modBase64", "base64Url", "Base32", "Base58", "QP" (for quoted-printable), "URL" (for url-encoding), "Hex", or any of the encodings found at Chilkat Binary Encodings List.
Returns 1 for success, 0 for failure.
topLoadFile
$status = $binData->LoadFile($path);
RemoveByteVal
$binData->RemoveByteVal($value);
Removes bytes having a specified value (0-255). For example, to remove all null bytes, pass 0 in value.
topRemoveChunk
# $numBytes is an integer
$retBool = $binData->RemoveChunk($offset, $numBytes);
SecureClear
Securely clears the contents by writing 0 bytes to the memory prior to deallocating the internal memory.
Returns 1 for success, 0 for failure.
topWriteAppendFile
$status = $binData->WriteAppendFile($path);
WriteFile
$status = $binData->WriteFile($path);