AwaClientGetResponse_GetValuesAs___ArrayPointer

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

Functions
AwaError	AwaClientGetResponse_GetValuesAsStringArrayPointer (const AwaClientGetResponse *response, const char *path, const AwaStringArray **valueArray)
AwaError	AwaClientGetResponse_GetValuesAsIntegerArrayPointer (const AwaClientGetResponse *response, const char *path, const AwaIntegerArray **valueArray)
AwaError	AwaClientGetResponse_GetValuesAsFloatArrayPointer (const AwaClientGetResponse *response, const char *path, const AwaFloatArray **valueArray)
AwaError	AwaClientGetResponse_GetValuesAsBooleanArrayPointer (const AwaClientGetResponse *response, const char *path, const AwaBooleanArray **valueArray)
AwaError	AwaClientGetResponse_GetValuesAsTimeArrayPointer (const AwaClientGetResponse *response, const char *path, const AwaTimeArray **valueArray)
AwaError	AwaClientGetResponse_GetValuesAsOpaqueArrayPointer (const AwaClientGetResponse *response, const char *path, const AwaOpaqueArray **valueArray)
AwaError	AwaClientGetResponse_GetValuesAsObjectLinkArrayPointer (const AwaClientGetResponse *response, const char *path, const AwaObjectLinkArray **valueArray)

Detailed Description

Retrieve a temporary pointer to a multiple-instance resource's array 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 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. 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_GetValuesAsStringArrayPointer	(	const AwaClientGetResponse *	response,
		const char *	path,
		const AwaStringArray **	valueArray
	)

AwaError AwaClientGetResponse_GetValuesAsIntegerArrayPointer	(	const AwaClientGetResponse *	response,
		const char *	path,
		const AwaIntegerArray **	valueArray
	)

Examples:

client-get-array-example.c.

AwaError AwaClientGetResponse_GetValuesAsFloatArrayPointer	(	const AwaClientGetResponse *	response,
		const char *	path,
		const AwaFloatArray **	valueArray
	)

AwaError AwaClientGetResponse_GetValuesAsBooleanArrayPointer	(	const AwaClientGetResponse *	response,
		const char *	path,
		const AwaBooleanArray **	valueArray
	)

AwaError AwaClientGetResponse_GetValuesAsTimeArrayPointer	(	const AwaClientGetResponse *	response,
		const char *	path,
		const AwaTimeArray **	valueArray
	)

AwaError AwaClientGetResponse_GetValuesAsOpaqueArrayPointer	(	const AwaClientGetResponse *	response,
		const char *	path,
		const AwaOpaqueArray **	valueArray
	)

AwaError AwaClientGetResponse_GetValuesAsObjectLinkArrayPointer	(	const AwaClientGetResponse *	response,
		const char *	path,
		const AwaObjectLinkArray **	valueArray
	)