AwaChangeSet_GetValueAs___Pointer

Retrieve a temporary pointer to a resource's value from a ChangeSet. More...

Functions
AwaError	AwaChangeSet_GetValueAsCStringPointer (const AwaChangeSet *changeSet, const char *path, const char **value)
AwaError	AwaChangeSet_GetValueAsIntegerPointer (const AwaChangeSet *changeSet, const char *path, const AwaInteger **value)
AwaError	AwaChangeSet_GetValueAsFloatPointer (const AwaChangeSet *changeSet, const char *path, const AwaFloat **value)
AwaError	AwaChangeSet_GetValueAsBooleanPointer (const AwaChangeSet *changeSet, const char *path, const AwaBoolean **value)
AwaError	AwaChangeSet_GetValueAsTimePointer (const AwaChangeSet *changeSet, const char *path, const AwaTime **value)
AwaError	AwaChangeSet_GetValueAsObjectLinkPointer (const AwaChangeSet *changeSet, const char *path, const AwaObjectLink **value)
AwaError	AwaChangeSet_GetValueAsOpaquePointer (const AwaChangeSet *changeSet, const char *path, const AwaOpaque **value)

Detailed Description

Retrieve a temporary pointer to a resource's 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 current ChangeSet to retrieve the value from.
[in]	path	The path of the resource requested for retrieval.
[in,out]	value	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_GetValueAsCStringPointer	(	const AwaChangeSet *	changeSet,
		const char *	path,
		const char **	value
	)

Examples:

client-subscribe-to-change-example.c, and server-observe-example.c.

AwaError AwaChangeSet_GetValueAsIntegerPointer	(	const AwaChangeSet *	changeSet,
		const char *	path,
		const AwaInteger **	value
	)

AwaError AwaChangeSet_GetValueAsFloatPointer	(	const AwaChangeSet *	changeSet,
		const char *	path,
		const AwaFloat **	value
	)

AwaError AwaChangeSet_GetValueAsBooleanPointer	(	const AwaChangeSet *	changeSet,
		const char *	path,
		const AwaBoolean **	value
	)

AwaError AwaChangeSet_GetValueAsTimePointer	(	const AwaChangeSet *	changeSet,
		const char *	path,
		const AwaTime **	value
	)

AwaError AwaChangeSet_GetValueAsObjectLinkPointer	(	const AwaChangeSet *	changeSet,
		const char *	path,
		const AwaObjectLink **	value
	)

AwaError AwaChangeSet_GetValueAsOpaquePointer	(	const AwaChangeSet *	changeSet,
		const char *	path,
		const AwaOpaque **	value
	)