AwaClientGetResponse_GetValueAs___Pointer

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

Functions
AwaError	AwaClientGetResponse_GetValueAsCStringPointer (const AwaClientGetResponse *response, const char *path, const char **value)
AwaError	AwaClientGetResponse_GetValueAsIntegerPointer (const AwaClientGetResponse *response, const char *path, const AwaInteger **value)
AwaError	AwaClientGetResponse_GetValueAsFloatPointer (const AwaClientGetResponse *response, const char *path, const AwaFloat **value)
AwaError	AwaClientGetResponse_GetValueAsBooleanPointer (const AwaClientGetResponse *response, const char *path, const AwaBoolean **value)
AwaError	AwaClientGetResponse_GetValueAsTimePointer (const AwaClientGetResponse *response, const char *path, const AwaTime **value)
AwaError	AwaClientGetResponse_GetValueAsObjectLinkPointer (const AwaClientGetResponse *response, const char *path, const AwaObjectLink **value)
AwaError	AwaClientGetResponse_GetValueAsOpaquePointer (const AwaClientGetResponse *response, const char *path, const AwaOpaque **value)

Detailed Description

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

The resource is identified by the path. This function can only be successful after a Get 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 Get 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 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 AwaClientGetResponse_GetValueAsCStringPointer	(	const AwaClientGetResponse *	response,
		const char *	path,
		const char **	value
	)

Examples:

client-get-contains-path-example.c, and client-get-example.c.

AwaError AwaClientGetResponse_GetValueAsIntegerPointer	(	const AwaClientGetResponse *	response,
		const char *	path,
		const AwaInteger **	value
	)

AwaError AwaClientGetResponse_GetValueAsFloatPointer	(	const AwaClientGetResponse *	response,
		const char *	path,
		const AwaFloat **	value
	)

AwaError AwaClientGetResponse_GetValueAsBooleanPointer	(	const AwaClientGetResponse *	response,
		const char *	path,
		const AwaBoolean **	value
	)

AwaError AwaClientGetResponse_GetValueAsTimePointer	(	const AwaClientGetResponse *	response,
		const char *	path,
		const AwaTime **	value
	)

AwaError AwaClientGetResponse_GetValueAsObjectLinkPointer	(	const AwaClientGetResponse *	response,
		const char *	path,
		const AwaObjectLink **	value
	)

AwaError AwaClientGetResponse_GetValueAsOpaquePointer	(	const AwaClientGetResponse *	response,
		const char *	path,
		const AwaOpaque **	value
	)