AwaServerReadResponse_GetValuesAs___ArrayPointer

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

Functions
AwaError	AwaServerReadResponse_GetValuesAsStringArrayPointer (const AwaServerReadResponse *response, const char *path, const AwaStringArray **valueArray)
AwaError	AwaServerReadResponse_GetValuesAsIntegerArrayPointer (const AwaServerReadResponse *response, const char *path, const AwaIntegerArray **valueArray)
AwaError	AwaServerReadResponse_GetValuesAsFloatArrayPointer (const AwaServerReadResponse *response, const char *path, const AwaFloatArray **valueArray)
AwaError	AwaServerReadResponse_GetValuesAsBooleanArrayPointer (const AwaServerReadResponse *response, const char *path, const AwaBooleanArray **valueArray)
AwaError	AwaServerReadResponse_GetValuesAsTimeArrayPointer (const AwaServerReadResponse *response, const char *path, const AwaTimeArray **valueArray)
AwaError	AwaServerReadResponse_GetValuesAsOpaqueArrayPointer (const AwaServerReadResponse *response, const char *path, const AwaOpaqueArray **valueArray)
AwaError	AwaServerReadResponse_GetValuesAsObjectLinkArrayPointer (const AwaServerReadResponse *response, const char *path, const AwaObjectLinkArray **valueArray)

Detailed Description

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

AwaError AwaServerReadResponse_GetValuesAsIntegerArrayPointer	(	const AwaServerReadResponse *	response,
		const char *	path,
		const AwaIntegerArray **	valueArray
	)

AwaError AwaServerReadResponse_GetValuesAsFloatArrayPointer	(	const AwaServerReadResponse *	response,
		const char *	path,
		const AwaFloatArray **	valueArray
	)

AwaError AwaServerReadResponse_GetValuesAsBooleanArrayPointer	(	const AwaServerReadResponse *	response,
		const char *	path,
		const AwaBooleanArray **	valueArray
	)

AwaError AwaServerReadResponse_GetValuesAsTimeArrayPointer	(	const AwaServerReadResponse *	response,
		const char *	path,
		const AwaTimeArray **	valueArray
	)

AwaError AwaServerReadResponse_GetValuesAsOpaqueArrayPointer	(	const AwaServerReadResponse *	response,
		const char *	path,
		const AwaOpaqueArray **	valueArray
	)

AwaError AwaServerReadResponse_GetValuesAsObjectLinkArrayPointer	(	const AwaServerReadResponse *	response,
		const char *	path,
		const AwaObjectLinkArray **	valueArray
	)