CkBinData Ruby Reference Documentation

CkBinData

Current Version: 9.5.0.75

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

Object Creation

obj = Chilkat::CkBinData.new()

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
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
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
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
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.

More Information and Examples
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
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
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
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