CkoBinData Objective-C Reference Documentation

CkoBinData

Current Version: 9.5.0.73

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

Object Creation

CkoBinData *obj = [[CkoBinData alloc] init];

Properties

LastMethodSuccess
@property (nonatomic) BOOL LastMethodSuccess;

Indicate whether the last method call succeeded or failed. A value of YES indicates success, a value of NO 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 = YES and failure = NO.
  • 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 YES. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
NumBytes
@property (nonatomic, readonly, copy) NSNumber *NumBytes;
Introduced in version 9.5.0.51

The number of bytes contained within the object.

top

Methods

AppendBd
- (BOOL)AppendBd:(CkoBinData *)binData;
Introduced in version 9.5.0.62

Appends the contents of another BinData to this object.

Returns YES for success, NO for failure.

top
AppendBinary
- (BOOL)AppendBinary:(NSData *)data;
Introduced in version 9.5.0.51

Appends binary data to the current contents, if any.

Returns YES for success, NO for failure.

top
AppendBom
- (BOOL)AppendBom:(NSString *)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 YES for success, NO for failure.

More Information and Examples
top
AppendEncoded
- (BOOL)AppendEncoded:(NSString *)encData
    encoding:(NSString *)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 YES for success, NO for failure.

top
AppendEncodedSb
- (BOOL)AppendEncodedSb:(CkoStringBuilder *)sb
    encoding:(NSString *)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 YES for success, NO for failure.

top
AppendSb
- (BOOL)AppendSb:(CkoStringBuilder *)sb
    charset:(NSString *)charset;
Introduced in version 9.5.0.62

Appends the contents of a StringBuilder to this object.

Returns YES for success, NO for failure.

More Information and Examples
top
AppendString
- (BOOL)AppendString:(NSString *)str
    charset:(NSString *)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 YES for success, NO for failure.

More Information and Examples
top
Clear
- (BOOL)Clear;
Introduced in version 9.5.0.51

Clears the contents.

Returns YES for success, NO for failure.

top
ContentsEqual
- (BOOL)ContentsEqual:(CkoBinData *)binData;
Introduced in version 9.5.0.62

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

top
GetBinary
- (NSData *)GetBinary;
Introduced in version 9.5.0.51

Retrieves the binary data contained within the object.

Returns nil on failure

top
GetBinaryChunk
- (NSData *)GetBinaryChunk:(NSNumber *)offset
    numBytes:(NSNumber *)numBytes;
Introduced in version 9.5.0.51

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

Returns nil on failure

top
GetEncoded
- (NSString *)GetEncoded:(NSString *)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 nil on failure

top
GetEncodedChunk
- (NSString *)GetEncodedChunk:(NSNumber *)offset
    numBytes:(NSNumber *)numBytes
    encoding:(NSString *)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 nil on failure

More Information and Examples
top
GetEncodedSb
- (BOOL)GetEncodedSb:(NSString *)encoding
    sb:(CkoStringBuilder *)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 YES for success, NO for failure.

More Information and Examples
top
GetString
- (NSString *)GetString:(NSString *)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 nil on failure

More Information and Examples
top
LoadBinary
- (BOOL)LoadBinary:(NSData *)data;
Introduced in version 9.5.0.51

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

Returns YES for success, NO for failure.

top
LoadEncoded
- (BOOL)LoadEncoded:(NSString *)encData
    encoding:(NSString *)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 YES for success, NO for failure.

top
LoadFile
- (BOOL)LoadFile:(NSString *)path;
Introduced in version 9.5.0.51

Loads data from a file.

Returns YES for success, NO for failure.

top
RemoveChunk
- (BOOL)RemoveChunk:(NSNumber *)offset
    numBytes:(NSNumber *)numBytes;
Introduced in version 9.5.0.51

Removes a chunk of bytes from the binary data.

More Information and Examples
top
SecureClear
- (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 YES for success, NO for failure.

top
WriteFile
- (BOOL)WriteFile:(NSString *)path;
Introduced in version 9.5.0.62

Writes the contents to a file.

Returns YES for success, NO for failure.

top