AwaServerReadResponse_GetValueAs___Pointer

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

Functions
AwaError	AwaServerReadResponse_GetValueAsCStringPointer (const AwaServerReadResponse *response, const char *path, const char **value)
AwaError	AwaServerReadResponse_GetValueAsIntegerPointer (const AwaServerReadResponse *response, const char *path, const AwaInteger **value)
AwaError	AwaServerReadResponse_GetValueAsFloatPointer (const AwaServerReadResponse *response, const char *path, const AwaFloat **value)
AwaError	AwaServerReadResponse_GetValueAsBooleanPointer (const AwaServerReadResponse *response, const char *path, const AwaBoolean **value)
AwaError	AwaServerReadResponse_GetValueAsTimePointer (const AwaServerReadResponse *response, const char *path, const AwaTime **value)
AwaError	AwaServerReadResponse_GetValueAsObjectLinkPointer (const AwaServerReadResponse *response, const char *path, const AwaObjectLink **value)
AwaError	AwaServerReadResponse_GetValueAsOpaquePointer (const AwaServerReadResponse *response, const char *path, const AwaOpaque **value)

Detailed Description

Retrieve a temporary pointer to a resource's value from a Read Response.

The resource is identified by the path. This function can only be successful after a Read operation has been successfully processed. The pointer is only valid while the operation is valid. If the operation is freed, the pointer returned is immediately invalid and should not be used or dereferenced.

Parameters

[in]	response	The current Read Response 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. Set to null on error.

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 Read 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 AwaServerReadResponse_GetValueAsCStringPointer	(	const AwaServerReadResponse *	response,
		const char *	path,
		const char **	value
	)

Examples:

server-read-example.c.

AwaError AwaServerReadResponse_GetValueAsIntegerPointer	(	const AwaServerReadResponse *	response,
		const char *	path,
		const AwaInteger **	value
	)

AwaError AwaServerReadResponse_GetValueAsFloatPointer	(	const AwaServerReadResponse *	response,
		const char *	path,
		const AwaFloat **	value
	)

AwaError AwaServerReadResponse_GetValueAsBooleanPointer	(	const AwaServerReadResponse *	response,
		const char *	path,
		const AwaBoolean **	value
	)

AwaError AwaServerReadResponse_GetValueAsTimePointer	(	const AwaServerReadResponse *	response,
		const char *	path,
		const AwaTime **	value
	)

AwaError AwaServerReadResponse_GetValueAsObjectLinkPointer	(	const AwaServerReadResponse *	response,
		const char *	path,
		const AwaObjectLink **	value
	)

AwaError AwaServerReadResponse_GetValueAsOpaquePointer	(	const AwaServerReadResponse *	response,
		const char *	path,
		const AwaOpaque **	value
	)