Built-in type consisting of a variable-length array of opaque bytes and a string that is the key. More...

#include <managed_keyedbytes.h>

Inheritance diagram for DDS::KeyedBytes:

Public Member Functions
	KeyedBytes ()
	Default Constructor. More...

	KeyedBytes (System::Int32 size)
	Constructor that specifies the allocated sizes. More...

virtual System::Boolean	copy_from (KeyedBytes^ src)
	Copy src into this object. More...

Public Attributes
System::String ^	key
	Instance key associated with the specified value. More...

System::Int32	length
	Number of bytes to serialize. More...

System::Int32	offset
	Offset from which to start serializing bytes. More...

array< System::Byte > ^	value
	DDS::Bytes array value. More...

Detailed Description

Built-in type consisting of a variable-length array of opaque bytes and a string that is the key.

Constructor & Destructor Documentation

◆ KeyedBytes() [1/2]

DDS::KeyedBytes::KeyedBytes ( )

Default Constructor.

The default constructor initializes the newly created object with empty key, null value, zero length, and zero offset.

◆ KeyedBytes() [2/2]

DDS::KeyedBytes::KeyedBytes ( System::Int32 size )

Constructor that specifies the allocated sizes.

After this method is called, key is initialized with the empty string and length and offset are set to zero.

Parameters

size	<<in>> Size of the allocated bytes array.

Member Function Documentation

◆ copy_from()

virtual System::Boolean DDS::KeyedBytes::copy_from ( KeyedBytes^ src )

virtual

Copy src into this object.

This method performs a deep copy of src and it allocates memory for the value if required.

Parameters

src	<<in>> Object to copy from.

Returns: true if success. Otherwise, false.

Exceptions

ArgumentNullException if src is null.

Reimplemented from DDS::ICopyable< KeyedBytes^>.

Member Data Documentation

◆ key

System::String ^ DDS::KeyedBytes::key

Instance key associated with the specified value.

Referenced by DDS::KeyedBytesDataReader::get_key_value(), and DDS::KeyedBytesDataReader::lookup_instance().

◆ length

System::Int32 DDS::KeyedBytes::length

Number of bytes to serialize.

◆ offset

System::Int32 DDS::KeyedBytes::offset

Offset from which to start serializing bytes.

The first position of the bytes array has offset 0.

◆ value

array<System::Byte> ^ DDS::KeyedBytes::value

DDS::Bytes array value.

Public Member Functions

Public Attributes