--------------------------------------------------------------------- CLASS: ByteArrayRef --JKH PUBLIC METHODS: Offset() - set/get the ByteArrayRef's offset Length() - set/get the ByteArrayRef's length theArray() - returns the ByteArray reference toMem() - copy from ByteArrayRef's subarray to specified memory fromMem() - copy to ByteArrayRef's subarray from specified memory isValid() - returns True if object is valid, False otherwise. (BYTE_PTR ) - casting operator: returns a BYTE_PTR pointing to ByteArrayRef's subarray. ByteArrayRef(BA) - use BA, at offset=0, len=BA.length() ByteArrayRef(BA,o,l) - use BA, at offset=o, len=l USAGE NOTES: Enjoy. ---------------------------------------------------------------------- --------------------------------------------------------------------- METHOD: ByteArrayRef::toMem() --JKH Copies the memory referenced by the ByteArrayRef to the specified data buffer. ARGS: BYTE_PTR buf OUT The data buffer. RETURNS: Returns True on success, False on failure. PRE-CONDS: --The ByteArrayRef is valid: its offset and length specify a valid region within the ByteArray to which the Ref refers. POST-CONDS: --Memory referenced by the ByteArrayRef will be copied to the specified data buffer. --If the ByteArrayRef is invalid, the function does nothing. ----------------------------------------------------------------------------- void NSR::String::toMem( CHAR_PTR s ) const void NSR::String::toMem( CHAR_PTR s ) const void NSR::SmallByteArray::toMem( BYTE_PTR b ) const void NSR::ByteArray::toMem( BYTE_PTR b ) const NSR::Boolean NSR::ByteArrayRef::toMem( BYTE_PTR buf ) const NSR::Boolean NSR::ByteArrayRef::toMem( BYTE_PTR buf ) const --------------------------------------------------------------------- METHOD: ByteArrayRef::fromMem() --JKH Copies from the specified data buffer to the memory referenced by the ByteArrayRef. ARGS: const BYTE_PTR buf IN The data buffer. RETURNS: Returns True on success, False on failure. PRE-CONDS: --The ByteArrayRef is valid: its offset and length specify a valid region with the ByteArray to which the Ref refers. POST-CONDS: --Memory from the specified data buffer will be copied to memory referenced by the ByteArrayRef. --If the ByteArrayRef is invalid, the function does nothing. ----------------------------------------------------------------------------- void NSR::SmallByteArray::fromMem( CONST_BYTE_PTR b ) void NSR::ByteArray::fromMem( CONST_BYTE_PTR b ) NSR::Boolean NSR::ByteArrayRef::fromMem( CONST_BYTE_PTR buf ) NSR::Boolean NSR::ByteArrayRef::fromMem( CONST_BYTE_PTR buf )