NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
IAttributeValueRef Class Referenceabstract

Provides direct access to the attribute value in the SENC. The data is locked in memory until the attribute object is released. More...

#include <gdb_attribute.h>

Inheritance diagram for IAttributeValueRef:
ISDKComponent

Public Member Functions

virtual GDBResult SDK_CALLTYPE GetValueLength (SDKUInt32 &length) const =0 throw ()
 Returns the length of the attribute value in bytes. More...
 
virtual GDBResult SDK_CALLTYPE CopyValue (SDKUInt32 length, SDKUInt8 *buffer) const =0 throw ()
 Copies an attribute value to the buffer. More...
 
virtual GDBResult SDK_CALLTYPE GetValueRef (SDKUInt32 *length, SDKUInt8 **value_ref) const =0 throw ()
 Returns the reference to the attribute value. Locks dataset data until the AttributeValueRef is released. More...
 
- Public Member Functions inherited from ISDKComponent
virtual SDKAtomicRefCount SDK_CALLTYPE AddRef () const =0 throw ()
 Increments the reference count for an interface on a component.

 
virtual SDKAtomicRefCount SDK_CALLTYPE Release () const =0 throw ()
 Decrements the reference count for an interface on a component.
 
virtual SDKResult SDK_CALLTYPE GetInterface (const InterfaceId &id, void **obj_ptr)=0 throw ()
 Returns pointers to the supported interfaces on a component.
 
template<typename _Itf >
SDKResult GetInterface (_Itf **obj_ptr) throw ()
 Returns pointers to the supported interfaces on a component.
 

Detailed Description

Provides direct access to the attribute value in the SENC. The data is locked in memory until the attribute object is released.

Member Function Documentation

◆ GetValueLength()

virtual GDBResult SDK_CALLTYPE GetValueLength ( SDKUInt32 &  length) const
throw (
)
pure virtual

Returns the length of the attribute value in bytes.

Parameters
[out]lengthAddress of a variable that receives the attribute value length.

◆ CopyValue()

virtual GDBResult SDK_CALLTYPE CopyValue ( SDKUInt32  length,
SDKUInt8 *  buffer 
) const
throw (
)
pure virtual

Copies an attribute value to the buffer.

Parameters
length[in] The buffer length.
buffer[out] Pointer to the buffer that receives the attribute value.
Returns
kSDKResult_Succeeded
kSDKResult_InvalidArgument

◆ GetValueRef()

virtual GDBResult SDK_CALLTYPE GetValueRef ( SDKUInt32 *  length,
SDKUInt8 **  value_ref 
) const
throw (
)
pure virtual

Returns the reference to the attribute value. Locks dataset data until the AttributeValueRef is released.

Parameters
[in]lengthPointer to a variable that receives the length of the attribute value.
[out]value_refAddress of a variable the receives the pointer to the attribute value.
Returns
kSDKResult_Succeeded
kSDKResult_InvalidArgument

The documentation for this class was generated from the following file: