Methods of the Bytes
class enable you to perform specific tasks related to Bytes
objects.
Table 12-9 Summary of Bytes Methods
Method | Summary |
---|---|
|
|
Returns the byte at the specified position of the |
|
Returns a byte array from the |
|
Tests whether the |
|
Returns the number of bytes in the |
|
Assignment operator for |
|
Sets the |
Bytes
class constructor.
Syntax | Description |
---|---|
Bytes( Environment *env = NULL); |
Creates a Bytes object. |
Bytes( unsigned char *value, unsigned int count unsigned int offset = 0, const Environment *env = NULL); |
Creates a Bytes object that contains a subarray of bytes from a character array. |
Bytes( const Bytes &e); |
Creates a copy of a Bytes object, use the syntax |
Parameter | Description |
---|---|
env |
Environment |
value |
Initial value of the new object |
count |
The size of the subset of the character array that will be copied into the new bytes object |
offset |
The first position from which to begin copying the character array |
e |
The source Bytes object. |
Returns the byte at the specified position in the Bytes
object.
unsigned char byteAt( unsigned int index) const;
Parameter | Description |
---|---|
index |
The position of the byte to be returned from the Bytes object; the first byte of the Bytes object is at 0. |
Copies bytes from a Bytes
object into the specified byte array.
void getBytes( unsigned char *dst, unsigned int count, unsigned int srcBegin = 0, unsigned int dstBegin = 0) const;
Parameter | Description |
---|---|
dst |
The destination buffer into which data from the Bytes object is to be written. |
count |
The number of bytes to copy. |
srcBegin |
The starting position at which data is to be read from the Bytes object; the position of the first byte in the Bytes object is at 0. |
dstBegin |
The starting position at which data is to be written in the destination buffer; the position of the first byte in dst is at 0. |
Tests whether the Bytes
object is atomically NULL
. If the Bytes
object is atomically NULL
, then TRUE
is returned; otherwise FALSE
is returned.
bool isNull() const;
This method returns the length of the Bytes
object.
unsigned int length() const;
Assignment operator for Bytes
class.
void operator=( const Bytes& bytes);
Parameter | Description |
---|---|
bytes |
The original Bytes . |
This method sets the Bytes
object to atomically NULL
.
void setNull();