CkBinData Python Reference Documentation

CkBinData

Current Version: 9.5.0.97

Container for binary data. Provides methods for getting, setting, appending, etc. in binary and string encoded formats.

Object Creation

obj = chilkat.CkBinData()

Properties

LastMethodSuccess
# boolVal is a boolean
boolVal = binData.get_LastMethodSuccess();
binData.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.

top
NumBytes
# intVal is an integer
intVal = binData.get_NumBytes();
Introduced in version 9.5.0.51

The number of bytes contained within the object.

top
Utf8
# boolVal is a boolean
boolVal = binData.get_Utf8();
binData.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.

top

Methods

AppendBd
# binData is a CkBinData
status = binData.AppendBd(binData);
Introduced in version 9.5.0.62

Appends the contents of another BinData to this object.

Returns True for success, False for failure.

top
AppendBinary
# data is a CkByteData
status = binData.AppendBinary(data);
Introduced in version 9.5.0.51

Appends binary data to the current contents, if any.

Returns True for success, False for failure.

top
AppendBom
# charset is a string
status = binData.AppendBom(charset);
Introduced in version 9.5.0.62

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 True for success, False for failure.

More Information and Examples
top
AppendByte
# byteValue is an integer
status = binData.AppendByte(byteValue);
Introduced in version 9.5.0.77

Appends a single byte. The byteValue should be a value from 0 to 255.

Returns True for success, False for failure.

top
AppendCountedString
# numCountBytes is an integer
# bigEndian is a boolean
# str is a string
# charset is a string
status = binData.AppendCountedString(numCountBytes, bigEndian, str, charset);
Introduced in version 9.5.0.91

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 True, 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 True for success, False for failure.

top
AppendEncoded
# encData is a string
# encoding is a string
status = binData.AppendEncoded(encData, encoding);
Introduced in version 9.5.0.51

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 True for success, False for failure.

top
AppendEncodedSb
# sb is a CkStringBuilder
# encoding is a string
status = binData.AppendEncodedSb(sb, encoding);
Introduced in version 9.5.0.62

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 True for success, False for failure.

top
AppendInt2
# value is an integer
# littleEndian is a boolean
status = binData.AppendInt2(value, littleEndian);
Introduced in version 9.5.0.77

Appends a 16-bit integer (2 bytes). If littleEndian is True, then the integer bytes are appended in little-endian byte order, otherwise big-endian byte order is used.

Returns True for success, False for failure.

More Information and Examples
top
AppendInt4
# value is an integer
# littleEndian is a boolean
status = binData.AppendInt4(value, littleEndian);
Introduced in version 9.5.0.77

Appends a 32-bit integer (4 bytes). If littleEndian is True, then the integer bytes are appended in little-endian byte order, otherwise big-endian byte order is used.

Returns True for success, False for failure.

More Information and Examples
top
AppendPadded
# str is a string
# charset is a string
# padWithSpace is a boolean
# fieldLen is an integer
status = binData.AppendPadded(str, charset, padWithSpace, fieldLen);
Introduced in version 9.5.0.80

Appends a string to this object, padded to the fieldLen with NULL or SPACE chars. If padWithSpace is True, then SPACE chars are used and the string is not null-terminated. If fieldLen is False, 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 False to indicate failure and nothing is appended.

Returns True for success, False for failure.

top
AppendSb
# sb is a CkStringBuilder
# charset is a string
status = binData.AppendSb(sb, charset);
Introduced in version 9.5.0.62

Appends the contents of a StringBuilder to this object.

Returns True for success, False for failure.

More Information and Examples
top
AppendString
# str is a string
# charset is a string
status = binData.AppendString(str, charset);
Introduced in version 9.5.0.62

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 True for success, False for failure.

More Information and Examples
top
Clear
status = binData.Clear();
Introduced in version 9.5.0.51

Clears the contents.

Returns True for success, False for failure.

top
ContentsEqual
# binData is a CkBinData
retBool = binData.ContentsEqual(binData);
Introduced in version 9.5.0.62

Return True if the contents of this object equals the contents of binData.

top
FindString
# str is a string
# startIdx is an integer
# charset is a string
retInt = binData.FindString(str, startIdx, charset);
Introduced in version 9.5.0.85

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.

top
GetBinary
# outBytes is a CkByteData (output)
status = binData.GetBinary(outData);
Introduced in version 9.5.0.51

Retrieves the binary data contained within the object.

Returns True for success, False for failure.

top
GetBinaryChunk
# offset is an integer
# numBytes is an integer
# outBytes is a CkByteData (output)
status = binData.GetBinaryChunk(offset, numBytes, outData);
Introduced in version 9.5.0.51

Retrieves a chunk of the binary data contained within the object.

Returns True for success, False for failure.

top
GetByte
# index is an integer
status = binData.GetByte(index);
Introduced in version 9.5.0.92

Returns the value of the byte at the given index. The returned value is an integer from 0 to 255.

Returns True for success, False for failure.

top
GetBytesPtr
binary_data = binData.GetBytesPtr();
Introduced in version 9.5.0.80

Returns a pointer to the internal buffer. Be careful with this method because if additional data is appended, the data within the object may be relocated and the pointer may cease to be valid.

top
GetEncoded
# encoding is a string
# outStr is a CkString (output)
status = binData.GetEncoded(encoding, outStr);
retStr = binData.getEncoded(encoding);
Introduced in version 9.5.0.51

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 True for success, False for failure.

top
GetEncodedChunk
# offset is an integer
# 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);
Introduced in version 9.5.0.51

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 True for success, False for failure.

More Information and Examples
top
GetEncodedSb
# encoding is a string
# sb is a CkStringBuilder
status = binData.GetEncodedSb(encoding, sb);
Introduced in version 9.5.0.64

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 True for success, False for failure.

top
GetHash
# algorithm is a string
# encoding is a string
# outStr is a CkString (output)
status = binData.GetHash(algorithm, encoding, outStr);
retStr = binData.getHash(algorithm, encoding);
Introduced in version 9.5.0.91

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 True for success, False for failure.

top
GetInt2
# index is an integer
# littleEndian is a boolean
retInt = binData.GetInt2(index, littleEndian);
Introduced in version 9.5.0.88

Returns the value of the 16-bit signed integer stored in big-endian or little-endian byte ordering at the given index.

top
GetInt4
# index is an integer
# littleEndian is a boolean
retInt = binData.GetInt4(index, littleEndian);
Introduced in version 9.5.0.88

Returns the value of the 32-bit signed integer stored in big-endian or little-endian byte ordering at the given index.

top
GetString
# charset is a string
# outStr is a CkString (output)
status = binData.GetString(charset, outStr);
retStr = binData.getString(charset);
Introduced in version 9.5.0.67

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 True for success, False for failure.

More Information and Examples
top
GetTextChunk
# startIdx is an integer
# 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);
Introduced in version 9.5.0.85

Returns numBytes bytes starting at startIdx. The bytes are interpreted according to charset (for example, "utf-8", "ansi", "utf-16", "windows-1252", etc.)

Returns True for success, False for failure.

top
GetUInt2
# index is an integer
# littleEndian is a boolean
retInt = binData.GetUInt2(index, littleEndian);
Introduced in version 9.5.0.88

Returns the value of the 16-bit unsigned integer stored in big-endian or little-endian byte ordering at the given index.

top
GetUInt4
# index is an integer
# littleEndian is a boolean
retInt = binData.GetUInt4(index, littleEndian);
Introduced in version 9.5.0.88

Returns the value of the 32-bit unsigned integer stored in big-endian or little-endian byte ordering at the given index.

top
LoadBinary
# data is a CkByteData
status = binData.LoadBinary(data);
Introduced in version 9.5.0.51

Loads binary data and replaces the current contents, if any.

Returns True for success, False for failure.

top
LoadEncoded
# encData is a string
# encoding is a string
status = binData.LoadEncoded(encData, encoding);
Introduced in version 9.5.0.51

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 True for success, False for failure.

top
LoadFile
# path is a string
status = binData.LoadFile(path);
Introduced in version 9.5.0.51

Loads data from a file.

Returns True for success, False for failure.

top
RemoveByteVal
# value is an integer
binData.RemoveByteVal(value);
Introduced in version 9.5.0.90

Removes bytes having a specified value (0-255). For example, to remove all null bytes, pass 0 in value.

top
RemoveChunk
# offset is an integer
# numBytes is an integer
retBool = binData.RemoveChunk(offset, numBytes);
Introduced in version 9.5.0.51

Removes a chunk of bytes from the binary data.

More Information and Examples
top
SecureClear
status = binData.SecureClear();
Introduced in version 9.5.0.67

Securely clears the contents by writing 0 bytes to the memory prior to deallocating the internal memory.

Returns True for success, False for failure.

top
WriteAppendFile
# path is a string
status = binData.WriteAppendFile(path);
Introduced in version 9.5.0.91

Appends the contents of this object to a file.

Returns True for success, False for failure.

top
WriteFile
# path is a string
status = binData.WriteFile(path);
Introduced in version 9.5.0.62

Writes the contents to a file.

Returns True for success, False for failure.

top