SHI_Data Class

Typed data values module. More...

Typedefs
typedef struct SHI_Data	SHI_Data
	A SHI_Data object represents a typed data object. More...

Functions
SHI_PUBLIC_API SHI_Result	SHI_Data_Release (SHI_Data *self)
	Releases this data object. More...
SHI_PUBLIC_API SHI_DataType	SHI_Data_GetType (SHI_Data *self)
	Gets the type of this data object's value. More...
SHI_PUBLIC_API const SHI_DataValue *	SHI_Data_GetValue (SHI_Data *self)
	Gets a pointer to this data object's value. More...

Detailed Description

Typed data values module.

Typedef Documentation

SHI_Data

typedef struct SHI_Data SHI_Data

A SHI_Data object represents a typed data object.

Function Documentation

SHI_Data_GetType()

SHI_PUBLIC_API SHI_DataType SHI_Data_GetType

(

SHI_Data *

self

)

Gets the type of this data object's value.

Parameters

self	The SHI_Data whose data type is obtained.

Returns

The data type.

SHI_Data_GetValue()

SHI_PUBLIC_API const SHI_DataValue* SHI_Data_GetValue

(

SHI_Data *

self

)

Gets a pointer to this data object's value.

The value pointed to is managed by this object. Thus, the caller does not need to free or release that value, as it will be freed or released when this object is released. In particular, when the value is of type SHI_DATA_TYPE_OBJECT, the object referenced in the value must not be independently released, even if it implements an interface that includes a Release() method.

Parameters

self	The SHI_Data whose value is obtained.

Returns

The data value.

SHI_Data_Release()

SHI_PUBLIC_API SHI_Result SHI_Data_Release

(

SHI_Data *

self

)

Releases this data object.

The object can no longer be used after this method returns.

Parameters

self	The SHI_Data to release.