BinData C# Reference Documentation

BinData

Current Version: 10.1.0

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

Object Creation

Chilkat.BinData obj = new Chilkat.BinData();

Properties

LastMethodSuccess

public bool LastMethodSuccess {get; set; }

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.

NumBytes

public int NumBytes {get; }

Introduced in version 9.5.0.51

The number of bytes contained within the object.

Methods

AppendBd

public bool AppendBd(BinData binData);

Introduced in version 9.5.0.62

Appends the contents of another BinData to this object.

Returns true for success, false for failure.

AppendBinary

public bool AppendBinary(byte[] data);

Introduced in version 9.5.0.51

Appends binary data to the current contents, if any.

Returns true for success, false for failure.

AppendBom

public bool AppendBom(string 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

(.NET Core C#) StringBuilder to Bytes (in BinData)(C#) StringBuilder to Bytes (in BinData)(Mono C#) StringBuilder to Bytes (in BinData)(PowerShell) StringBuilder to Bytes (in BinData)

AppendByte

public bool AppendByte(int 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.

AppendCountedString

public bool AppendCountedString(int numCountBytes, bool bigEndian, string str, string 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.

AppendEncoded

public bool AppendEncoded(string encData, string 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.

More Information and Examples

(.NET Core C#) Demonstrate Binary Data Encoding Methods (C#) Demonstrate Binary Data Encoding Methods (Mono C#) Demonstrate Binary Data Encoding Methods (PowerShell) Demonstrate Binary Data Encoding Methods (.NET Core C#) Decode Base64 Image String (GIF, JPG, etc.) and Save to File (C#) Decode Base64 Image String (GIF, JPG, etc.) and Save to File (Mono C#) Decode Base64 Image String (GIF, JPG, etc.) and Save to File (PowerShell) Decode Base64 Image String (GIF, JPG, etc.) and Save to File (.NET Core C#) Convert any File to Base64 (and back)(C#) Convert any File to Base64 (and back)(Mono C#) Convert any File to Base64 (and back)(PowerShell) Convert any File to Base64 (and back)(.NET Core C#) Decode Base64 (C#) Decode Base64 (Mono C#) Decode Base64 (PowerShell) Decode Base64

AppendEncodedSb

public bool AppendEncodedSb(StringBuilder sb, string 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.

More Information and Examples

(.NET Core C#) Extract PDF Invoice from FatturaElettronica XML (C#) Extract PDF Invoice from FatturaElettronica XML (Mono C#) Extract PDF Invoice from FatturaElettronica XML (PowerShell) Extract PDF Invoice from FatturaElettronica XML

AppendInt2

public bool AppendInt2(int value, bool 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

(.NET Core C#) Append Big-Endian or Little-Endian Integers (C#) Append Big-Endian or Little-Endian Integers (Mono C#) Append Big-Endian or Little-Endian Integers (PowerShell) Append Big-Endian or Little-Endian Integers

AppendInt4

public bool AppendInt4(int value, bool 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

(.NET Core C#) Append Big-Endian or Little-Endian Integers (C#) Append Big-Endian or Little-Endian Integers (Mono C#) Append Big-Endian or Little-Endian Integers (PowerShell) Append Big-Endian or Little-Endian Integers

AppendPadded

public bool AppendPadded(string str, string charset, bool padWithSpace, int 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.

More Information and Examples

(.NET Core C#) Duplicate PHP's openssl_encrypt and openssl_random_pseudo_bytes (C#) Duplicate PHP's openssl_encrypt and openssl_random_pseudo_bytes (Mono C#) Duplicate PHP's openssl_encrypt and openssl_random_pseudo_bytes (PowerShell) Duplicate PHP's openssl_encrypt and openssl_random_pseudo_bytes

AppendSb

public bool AppendSb(StringBuilder sb, string 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

(.NET Core C#) StringBuilder to Bytes (in BinData)(C#) StringBuilder to Bytes (in BinData)(Mono C#) StringBuilder to Bytes (in BinData)(PowerShell) StringBuilder to Bytes (in BinData)

AppendString

public bool AppendString(string str, string 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

(.NET Core C#) Appending Strings to BinData (C#) Appending Strings to BinData (Mono C#) Appending Strings to BinData (PowerShell) Appending Strings to BinData

Clear

public bool Clear();

Introduced in version 9.5.0.51

Clears the contents.

Returns true for success, false for failure.

ContentsEqual

public bool ContentsEqual(BinData binData);

Introduced in version 9.5.0.62

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

FindString

public int FindString(string str, int startIdx, string 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.

GetBinary

public byte[] GetBinary();

Introduced in version 9.5.0.51

Retrieves the binary data contained within the object.

Returns an empty byte array on failure

GetBinaryChunk

public byte[] GetBinaryChunk(int offset, int numBytes);

Introduced in version 9.5.0.51

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

Returns an empty byte array on failure

GetByte

public int GetByte(int 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.

GetEncoded

public string GetEncoded(string 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 null on failure

More Information and Examples

(.NET Core C#) Demonstrate Binary Data Encoding Methods (C#) Demonstrate Binary Data Encoding Methods (Mono C#) Demonstrate Binary Data Encoding Methods (PowerShell) Demonstrate Binary Data Encoding Methods (.NET Core C#) Determine File Type from Binary Content of File (C#) Determine File Type from Binary Content of File (Mono C#) Determine File Type from Binary Content of File (PowerShell) Determine File Type from Binary Content of File (.NET Core C#) Get Contents of File as Base64 (C#) Get Contents of File as Base64 (Mono C#) Get Contents of File as Base64 (PowerShell) Get Contents of File as Base64

GetEncodedChunk

public string GetEncodedChunk(int offset, int numBytes, string 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 null on failure

More Information and Examples

(.NET Core C#) Demonstrate Binary Data Encoding Methods (C#) Demonstrate Binary Data Encoding Methods (Mono C#) Demonstrate Binary Data Encoding Methods (PowerShell) Demonstrate Binary Data Encoding Methods

GetEncodedSb

public bool GetEncodedSb(string encoding, StringBuilder 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

(.NET Core C#) Append Encoded Binary Data to StringBuilder (C#) Append Encoded Binary Data to StringBuilder (Mono C#) Append Encoded Binary Data to StringBuilder (PowerShell) Append Encoded Binary Data to StringBuilder (.NET Core C#) Demonstrate Binary Data Encoding Methods (C#) Demonstrate Binary Data Encoding Methods (Mono C#) Demonstrate Binary Data Encoding Methods (PowerShell) Demonstrate Binary Data Encoding Methods

GetHash

public string GetHash(string algorithm, string 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 null on failure

GetInt2

public int GetInt2(int index, bool 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.

GetInt4

public int GetInt4(int index, bool 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.

GetString

public string GetString(string 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 null on failure

More Information and Examples

Chilkat Supported Character Encodings

GetTextChunk

public string GetTextChunk(int startIdx, int numBytes, string 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 null on failure

GetUInt2

public uint GetUInt2(int index, bool 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.

GetUInt4

public uint GetUInt4(int index, bool 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.

IsValidUtf8

public bool IsValidUtf8();

Introduced in version 10.1.0

Returns true 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 false.

Returns true for success, false for failure.

LoadBinary

public bool LoadBinary(byte[] 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.

LoadEncoded

public bool LoadEncoded(string encData, string 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.

LoadFile

public bool LoadFile(string path);

Introduced in version 9.5.0.51

Loads data from a file.

Returns true for success, false for failure.

RemoveByteVal

public void RemoveByteVal(int 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.

RemoveChunk

public bool RemoveChunk(int offset, int numBytes);

Introduced in version 9.5.0.51

Removes a chunk of bytes from the binary data.

More Information and Examples

(.NET Core C#) Demonstrate Binary Data Encoding Methods (C#) Demonstrate Binary Data Encoding Methods (Mono C#) Demonstrate Binary Data Encoding Methods (PowerShell) Demonstrate Binary Data Encoding Methods

SecureClear

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

WriteAppendFile

public bool WriteAppendFile(string path);

Introduced in version 9.5.0.91

Appends the contents of this object to a file.

Returns true for success, false for failure.

WriteFile

public bool WriteFile(string path);

Introduced in version 9.5.0.62

Writes the contents to a file.

Returns true for success, false for failure.