AwaChangeSet_GetValuesAs___ArrayPointer

Retrieve a temporary pointer to a multiple-instance resource's array value from a ChangeSet. More...

Functions
AwaError	AwaChangeSet_GetValuesAsStringArrayPointer (const AwaChangeSet *changeSet, const char *path, const AwaStringArray **valueArray)
AwaError	AwaChangeSet_GetValuesAsIntegerArrayPointer (const AwaChangeSet *changeSet, const char *path, const AwaIntegerArray **valueArray)
AwaError	AwaChangeSet_GetValuesAsFloatArrayPointer (const AwaChangeSet *changeSet, const char *path, const AwaFloatArray **valueArray)
AwaError	AwaChangeSet_GetValuesAsBooleanArrayPointer (const AwaChangeSet *changeSet, const char *path, const AwaBooleanArray **valueArray)
AwaError	AwaChangeSet_GetValuesAsTimeArrayPointer (const AwaChangeSet *changeSet, const char *path, const AwaTimeArray **valueArray)
AwaError	AwaChangeSet_GetValuesAsOpaqueArrayPointer (const AwaChangeSet *changeSet, const char *path, const AwaOpaqueArray **valueArray)
AwaError	AwaChangeSet_GetValuesAsObjectLinkArrayPointer (const AwaChangeSet *changeSet, const char *path, const AwaObjectLinkArray **valueArray)

Detailed Description

Retrieve a temporary pointer to a multiple-instance resource's array value from a ChangeSet.

The resource is identified by the path. ChangeSets will contain values for any resources that have been created or modified. The pointer is only valid while within its Subscription or Observation callback. Once the callback exits the changeSet is freed and any pointers returned are immediately invalid and should no longer be used or dereferenced.

Parameters

[in]	changeSet	The ChangeSet to retrieve the value from.
[in]	path	The path of the multiple-instance resource requested for retrieval.
[in,out]	valueArray	A pointer to a const pointer that will be modified to point to the requested value.

Returns

AwaError_Success on success.

AwaError_TypeMismatch if the resource type corresponding to the specified path is not of the correct type.

AwaError_PathNotFound if the specified resource path is not covered by the Get Response.

AwaError_OperationInvalid if the specified operation is invalid or NULL.

AwaError_PathInvalid if the specified path is invalid or does not correspond to a resource path.

Function Documentation

AwaError AwaChangeSet_GetValuesAsStringArrayPointer	(	const AwaChangeSet *	changeSet,
		const char *	path,
		const AwaStringArray **	valueArray
	)

AwaError AwaChangeSet_GetValuesAsIntegerArrayPointer	(	const AwaChangeSet *	changeSet,
		const char *	path,
		const AwaIntegerArray **	valueArray
	)

AwaError AwaChangeSet_GetValuesAsFloatArrayPointer	(	const AwaChangeSet *	changeSet,
		const char *	path,
		const AwaFloatArray **	valueArray
	)

AwaError AwaChangeSet_GetValuesAsBooleanArrayPointer	(	const AwaChangeSet *	changeSet,
		const char *	path,
		const AwaBooleanArray **	valueArray
	)

AwaError AwaChangeSet_GetValuesAsTimeArrayPointer	(	const AwaChangeSet *	changeSet,
		const char *	path,
		const AwaTimeArray **	valueArray
	)

AwaError AwaChangeSet_GetValuesAsOpaqueArrayPointer	(	const AwaChangeSet *	changeSet,
		const char *	path,
		const AwaOpaqueArray **	valueArray
	)

AwaError AwaChangeSet_GetValuesAsObjectLinkArrayPointer	(	const AwaChangeSet *	changeSet,
		const char *	path,
		const AwaObjectLinkArray **	valueArray
	)