--- product: Chilkat product_version: 11.7.0 language: ckruby language_label: Ruby class: BinData class_name: CkBinData license: free deprecated: false reference_html: https://www.chilkatsoft.com/refdoc/rubyCkBinDataRef.html --- # Chilkat BinData — Ruby — v11.7.0 > Chilkat 11.7.0 · language=ckruby · class=BinData (CkBinData) > Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0//classes/BinData.md`. > Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/ckruby/guide.md`. ## Purpose **Build, transform, encode, decode, inspect, and save binary data.** `Chilkat.BinData` is a general-purpose mutable byte container used throughout Chilkat for working with binary content in memory. It can load bytes from files, byte arrays, strings, and encoded text; append additional data in many forms; retrieve content as raw bytes, chunks, text, or encoded strings; compute hashes; convert character encodings; validate UTF-8; remove byte ranges; and write the final result to files. **Load binary content** Load data from files, byte arrays, strings, encoded strings, or other Chilkat objects that produce binary output. **Append and build data** Append bytes, strings, integers, BOMs, counted strings, padded fields, encoded data, and other `BinData` objects. **Encode and decode** Convert binary data to and from text encodings such as Base64, hex, URL encoding, and other supported binary encodings. **Text and charset handling** Interpret bytes as text, append strings using a specified charset, convert character encodings, and validate UTF-8 content. **Inspect and modify bytes** Get byte counts, extract chunks, remove ranges, compare data, and work with specific portions of a binary buffer. **Hash and save output** Compute hashes for the contained data and write the resulting bytes to files or pass them to other Chilkat classes. **Common pattern:** Load or append binary data, perform any needed encoding, decoding, hashing, charset conversion, or byte-level edits, then retrieve the result as bytes, text, an encoded string, or a file. Use `BinData` whenever a Chilkat method needs a mutable in-memory binary buffer. For an extended overview, see [BinData Class Overview](https://www.chilkatsoft.com/bindata_class_overview.asp). ## Object creation, unlocking and error handling **Object Creation** ```ruby obj = Chilkat::CkBinData.new() ``` Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in Ruby. How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called. ## Members common to every Chilkat class Documented once per language in `common-members.md`; listed here so this page is self-contained. | Property | Signature | Access | Meaning | |---|---|---|---| | `DebugLogFilePath` | `# strVal is a string # ckStr is a CkString binData.get_DebugLogFilePath(ckStr); strVal = binData.debugLogFilePath(); binData.put_DebugLogFilePath(strVal);` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. | | `LastErrorHtml` | `# strVal is a string # ckStr is a CkString binData.get_LastErrorHtml(ckStr); strVal = binData.lastErrorHtml();` | read-only | Provides HTML-formatted information about the last called method or property. | | `LastErrorText` | `# strVal is a string # ckStr is a CkString binData.get_LastErrorText(ckStr); strVal = binData.lastErrorText();` | read-only | Provides plain text information about the last called method or property. | | `LastErrorXml` | `# strVal is a string # ckStr is a CkString binData.get_LastErrorXml(ckStr); strVal = binData.lastErrorXml();` | read-only | Provides XML-formatted information about the last called method or property. | | `LastMethodSuccess` | `# boolVal is a boolean boolVal = binData.get_LastMethodSuccess(); binData.put_LastMethodSuccess(boolVal);` | read/write | Indicates the success or failure of the most recent method call: `true` means success, `false` means failure. | | `Utf8` | `# boolVal is a boolean boolVal = binData.get_Utf8(); binData.put_Utf8(boolVal);` | read/write | When set to `true`, all `string` arguments and return values are interpreted as UTF-8 strings. | | `VerboseLogging` | `# boolVal is a boolean boolVal = binData.get_VerboseLogging(); binData.put_VerboseLogging(boolVal);` | read/write | If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. | | `Version` | `# strVal is a string # ckStr is a CkString binData.get_Version(ckStr); strVal = binData.version();` | read-only | Version of the component/library, such as "10.1.0" | ## Member index | Member | Kind | Signature | |---|---|---| | `NumBytes` | property, read-only | `# intVal is an integer intVal = binData.get_NumBytes();` | | `AppendBd` | method | `# binData is a CkBinData status = binData.AppendBd(binData);` | | `AppendBom` | method | `# charset is a string status = binData.AppendBom(charset);` | | `AppendByte` | method | `# byteValue is an integer status = binData.AppendByte(byteValue);` | | `AppendCountedString` | method | `# numCountBytes is an integer # bigEndian is a boolean # str is a string # charset is a string status = binData.AppendCountedString(numCountBytes, bigEndian, str, charset);` | | `AppendData` | method | `# data is a binary string # numBytes is an integer status = binData.AppendData(data, numBytes);` | | `AppendEncoded` | method | `# encData is a string # encoding is a string status = binData.AppendEncoded(encData, encoding);` | | `AppendEncodedSb` | method | `# sb is a CkStringBuilder # encoding is a string status = binData.AppendEncodedSb(sb, encoding);` | | `AppendInt2` | method | `# value is an integer # littleEndian is a boolean status = binData.AppendInt2(value, littleEndian);` | | `AppendInt4` | method | `# value is an integer # littleEndian is a boolean status = binData.AppendInt4(value, littleEndian);` | | `AppendPadded` | method | `# str is a string # charset is a string # padWithSpace is a boolean # fieldLen is an integer status = binData.AppendPadded(str, charset, padWithSpace, fieldLen);` | | `AppendSb` | method | `# sb is a CkStringBuilder # charset is a string status = binData.AppendSb(sb, charset);` | | `AppendString` | method | `# str is a string # charset is a string status = binData.AppendString(str, charset);` | | `ByteSwap` | method | `# size is an integer status = binData.ByteSwap(size);` | | `CharsetConvert` | method | `# fromCharset is a string # toCharset is a string # allOrNone is a boolean status = binData.CharsetConvert(fromCharset, toCharset, allOrNone);` | | `Clear` | method | `status = binData.Clear();` | | `ContentsEqual` | method | `# binData is a CkBinData retBool = binData.ContentsEqual(binData);` | | `FindString` | method | `# str is a string # startIdx is an integer # charset is a string retInt = binData.FindString(str, startIdx, charset);` | | `GetByte` | method | `# index is an integer status = binData.GetByte(index);` | | `GetData` | method | `binaryString = binData.GetData();` | | `GetDataChunk` | method | `# offset is an integer # numBytes is an integer binaryString = binData.GetDataChunk(offset, numBytes);` | | `GetEncoded` | method | `# encoding is a string # outStr is a CkString (output) status = binData.GetEncoded(encoding, outStr); retStr = binData.getEncoded(encoding);` | | `GetEncodedChunk` | method | `# 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);` | | `GetEncodedSb` | method | `# encoding is a string # sb is a CkStringBuilder status = binData.GetEncodedSb(encoding, sb);` | | `GetHash` | method | `# algorithm is a string # encoding is a string # outStr is a CkString (output) status = binData.GetHash(algorithm, encoding, outStr); retStr = binData.getHash(algorithm, encoding);` | | `GetInt2` | method | `# index is an integer # littleEndian is a boolean retInt = binData.GetInt2(index, littleEndian);` | | `GetInt4` | method | `# index is an integer # littleEndian is a boolean retInt = binData.GetInt4(index, littleEndian);` | | `GetString` | method | `# charset is a string # outStr is a CkString (output) status = binData.GetString(charset, outStr); retStr = binData.getString(charset);` | | `GetTextChunk` | method | `# 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);` | | `GetUInt2` | method | `# index is an integer # littleEndian is a boolean retInt = binData.GetUInt2(index, littleEndian);` | | `GetUInt4` | method | `# index is an integer # littleEndian is a boolean retInt = binData.GetUInt4(index, littleEndian);` | | `IsValidUtf8` | method | `status = binData.IsValidUtf8();` | | `LoadEncoded` | method | `# encData is a string # encoding is a string status = binData.LoadEncoded(encData, encoding);` | | `LoadFile` | method | `# path is a string status = binData.LoadFile(path);` | | `RemoveByteVal` | method | `# value is an integer binData.RemoveByteVal(value);` | | `RemoveChunk` | method | `# offset is an integer # numBytes is an integer status = binData.RemoveChunk(offset, numBytes);` | | `SecureClear` | method | `status = binData.SecureClear();` | | `WriteAppendFile` | method | `# path is a string status = binData.WriteAppendFile(path);` | | `WriteFile` | method | `# path is a string status = binData.WriteFile(path);` | Deprecated members are listed at the end of this file with their replacements; do not use them in new code. ## Properties ### BinData.NumBytes `Chilkat 11.7.0 · ckruby · BinData · NumBytes · property · read-only · since 9.5.0.51` ```ruby # intVal is an integer intVal = binData.get_NumBytes(); ``` The number of bytes contained within the object. ## Methods ### BinData.AppendBd `Chilkat 11.7.0 · ckruby · BinData · AppendBd · method · since 9.5.0.62` ```ruby # binData is a CkBinData status = binData.AppendBd(binData); ``` Appends the contents of another BinData to this object. Returns true for success, false for failure. ### BinData.AppendBom `Chilkat 11.7.0 · ckruby · BinData · AppendBom · method · since 9.5.0.62` ```ruby # charset is a string 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 true for success, false for failure. ### BinData.AppendByte `Chilkat 11.7.0 · ckruby · BinData · AppendByte · method · since 9.5.0.77` ```ruby # byteValue is an integer status = binData.AppendByte(byteValue); ``` Appends a single byte. The `byteValue` should be a value from 0 to 255. Returns true for success, false for failure. ### BinData.AppendCountedString `Chilkat 11.7.0 · ckruby · BinData · AppendCountedString · method · since 9.5.0.91` ```ruby # numCountBytes is an integer # 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 `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. ### BinData.AppendData `Chilkat 11.7.0 · ckruby · BinData · AppendData · method · since 11.0.0` ```ruby # data is a binary string # numBytes is an integer status = binData.AppendData(data, numBytes); ``` Appends binary data to the current contents. Returns true for success, false for failure. ### BinData.AppendEncoded `Chilkat 11.7.0 · ckruby · BinData · AppendEncoded · method · since 9.5.0.51` ```ruby # encData is a string # 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](https://www.chilkatsoft.com/binary_encodings.asp). Returns true for success, false for failure. ### BinData.AppendEncodedSb `Chilkat 11.7.0 · ckruby · BinData · AppendEncodedSb · method · since 9.5.0.62` ```ruby # sb is a CkStringBuilder # 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](https://www.chilkatsoft.com/binary_encodings.asp). Returns true for success, false for failure. ### BinData.AppendInt2 `Chilkat 11.7.0 · ckruby · BinData · AppendInt2 · method · since 9.5.0.77` ```ruby # value is an integer # littleEndian is a boolean status = binData.AppendInt2(value, littleEndian); ``` 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. ### BinData.AppendInt4 `Chilkat 11.7.0 · ckruby · BinData · AppendInt4 · method · since 9.5.0.77` ```ruby # value is an integer # littleEndian is a boolean status = binData.AppendInt4(value, littleEndian); ``` 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. ### BinData.AppendPadded `Chilkat 11.7.0 · ckruby · BinData · AppendPadded · method · since 9.5.0.80` ```ruby # str is a string # 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 `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. ### BinData.AppendSb `Chilkat 11.7.0 · ckruby · BinData · AppendSb · method · since 9.5.0.62` ```ruby # sb is a CkStringBuilder # charset is a string status = binData.AppendSb(sb, charset); ``` Appends the contents of a StringBuilder to this object. Returns true for success, false for failure. ### BinData.AppendString `Chilkat 11.7.0 · ckruby · BinData · AppendString · method · since 9.5.0.62` ```ruby # str is a string # 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 true for success, false for failure. ### BinData.ByteSwap `Chilkat 11.7.0 · ckruby · BinData · ByteSwap · method · since 11.0.0` ```ruby # size is an integer 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) ### BinData.CharsetConvert `Chilkat 11.7.0 · ckruby · BinData · CharsetConvert · method · since 11.0.0` ```ruby # fromCharset is a string # 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 `true`, the object's contents remain unchanged when errors occur. If `false`, error bytes are discarded. The method returns `true` if successful and `false` if errors occur. Returns true for success, false for failure. ### BinData.Clear `Chilkat 11.7.0 · ckruby · BinData · Clear · method · since 9.5.0.51` ```ruby status = binData.Clear(); ``` Clears the contents. Returns true for success, false for failure. ### BinData.ContentsEqual `Chilkat 11.7.0 · ckruby · BinData · ContentsEqual · method · since 9.5.0.62` ```ruby # binData is a CkBinData retBool = binData.ContentsEqual(binData); ``` Return `true` if the contents of this object equals the contents of `binData`. ### BinData.FindString `Chilkat 11.7.0 · ckruby · BinData · FindString · method · since 9.5.0.85` ```ruby # str is a string # 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. ### BinData.GetByte `Chilkat 11.7.0 · ckruby · BinData · GetByte · method · since 9.5.0.92` ```ruby # index is an integer status = binData.GetByte(index); ``` Returns the value of the byte at the given `index`. The returned value is an integer from 0 to 255. ### BinData.GetData `Chilkat 11.7.0 · ckruby · BinData · GetData · method · since 11.0.0` ```ruby binaryString = binData.GetData(); ``` Retrieves the binary data contained within the object. Returns `nil` on failure ### BinData.GetDataChunk `Chilkat 11.7.0 · ckruby · BinData · GetDataChunk · method · since 11.0.0` ```ruby # offset is an integer # numBytes is an integer binaryString = binData.GetDataChunk(offset, numBytes); ``` Retrieves a chunk of the binary data contained within the object. Returns `nil` on failure ### BinData.GetEncoded `Chilkat 11.7.0 · ckruby · BinData · GetEncoded · method · since 9.5.0.51` ```ruby # encoding is a string # 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](https://www.chilkatsoft.com/binary_encodings.asp). Returns true for success, false for failure. ### BinData.GetEncodedChunk `Chilkat 11.7.0 · ckruby · BinData · GetEncodedChunk · method · since 9.5.0.51` ```ruby # 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); ``` 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](https://www.chilkatsoft.com/binary_encodings.asp). Returns true for success, false for failure. ### BinData.GetEncodedSb `Chilkat 11.7.0 · ckruby · BinData · GetEncodedSb · method · since 9.5.0.64` ```ruby # encoding is a string # 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](https://www.chilkatsoft.com/binary_encodings.asp). Returns true for success, false for failure. ### BinData.GetHash `Chilkat 11.7.0 · ckruby · BinData · GetHash · method · since 9.5.0.91` ```ruby # algorithm is a string # 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](https://www.chilkatsoft.com/binary_encodings.asp). Returns true for success, false for failure. ### BinData.GetInt2 `Chilkat 11.7.0 · ckruby · BinData · GetInt2 · method · since 9.5.0.88` ```ruby # index is an integer # 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. ### BinData.GetInt4 `Chilkat 11.7.0 · ckruby · BinData · GetInt4 · method · since 9.5.0.88` ```ruby # index is an integer # 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. ### BinData.GetString `Chilkat 11.7.0 · ckruby · BinData · GetString · method · since 9.5.0.67` ```ruby # charset is a string # 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 true for success, false for failure. See also: - [Chilkat Supported Character Encodings](http://cknotes.com/chilkat-charsets-character-encodings-supported/) ### BinData.GetTextChunk `Chilkat 11.7.0 · ckruby · BinData · GetTextChunk · method · since 9.5.0.85` ```ruby # 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); ``` 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. ### BinData.GetUInt2 `Chilkat 11.7.0 · ckruby · BinData · GetUInt2 · method · since 9.5.0.88` ```ruby # index is an integer # 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. ### BinData.GetUInt4 `Chilkat 11.7.0 · ckruby · BinData · GetUInt4 · method · since 9.5.0.88` ```ruby # index is an integer # 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. ### BinData.IsValidUtf8 `Chilkat 11.7.0 · ckruby · BinData · IsValidUtf8 · method · since 10.1.0` ```ruby status = binData.IsValidUtf8(); ``` 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. ### BinData.LoadEncoded `Chilkat 11.7.0 · ckruby · BinData · LoadEncoded · method · since 9.5.0.51` ```ruby # encData is a string # 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](https://www.chilkatsoft.com/binary_encodings.asp). Returns true for success, false for failure. ### BinData.LoadFile `Chilkat 11.7.0 · ckruby · BinData · LoadFile · method · since 9.5.0.51` ```ruby # path is a string status = binData.LoadFile(path); ``` Loads data from a file. Returns true for success, false for failure. ### BinData.RemoveByteVal `Chilkat 11.7.0 · ckruby · BinData · RemoveByteVal · method · since 9.5.0.90` ```ruby # value is an integer binData.RemoveByteVal(value); ``` Removes bytes having a specified value (0-255). For example, to remove all null bytes, pass 0 in `value`. ### BinData.RemoveChunk `Chilkat 11.7.0 · ckruby · BinData · RemoveChunk · method · since 9.5.0.51` ```ruby # offset is an integer # numBytes is an integer status = binData.RemoveChunk(offset, numBytes); ``` Removes a chunk of bytes from the binary data. Returns true for success, false for failure. ### BinData.SecureClear `Chilkat 11.7.0 · ckruby · BinData · SecureClear · method · since 9.5.0.67` ```ruby status = binData.SecureClear(); ``` Securely clears the contents by writing 0 bytes to the memory prior to deallocating the internal memory. Returns true for success, false for failure. ### BinData.WriteAppendFile `Chilkat 11.7.0 · ckruby · BinData · WriteAppendFile · method · since 9.5.0.91` ```ruby # path is a string status = binData.WriteAppendFile(path); ``` Appends the contents of this object to a file. Returns true for success, false for failure. ### BinData.WriteFile `Chilkat 11.7.0 · ckruby · BinData · WriteFile · method · since 9.5.0.62` ```ruby # path is a string status = binData.WriteFile(path); ``` Writes the contents to a file. Returns true for success, false for failure. ## Deprecated members — do not use in new code | Member | Kind | Deprecated in | Use instead | |---|---|---|---| | `AppendBinary` | method | before 11.6.1 | — | | `GetBinary` | method | before 11.6.1 | — | | `GetBinaryChunk` | method | before 11.6.1 | — | | `LoadBinary` | method | before 11.6.1 | — | ## Related classes [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/ckruby/classes/StringBuilder.md)