PrlResult_GetParamByIndexAsString Function

Obtains a string result from the result object identified by the index.

Syntax

PRL_RESULT PrlResult_GetParamByIndexAsString(
    PRL_HANDLE hResult, 
    PRL_UINT32 nIndex, 
    PRL_STR sParamBuf, 
    PRL_UINT32_PTR pnParamBufSize
);

File

PrlApiCore.h

Parameters

hResult

A handle of type PHT_RESULT identifying the result object.

nIndex

An index identifying the string item in the list.

sParamBuf

[out] A pointer to a buffer that receives the result (a UTF-8 encoded, null-terminated string).

pnParamBufSize

[in] The size of the output buffer (in bytes). Set the buffer pointer to null and this parameter's value to zero to receive the required size. [out] The required output buffer size.

Returns

PRL_RESULT. Possible values are:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_BUFFER_OVERRUN - the size of the output buffer is not large enough. The parameter that is used to specify the size will contain the required size.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

Use this function when the result contains (or may contain) multiple string items. To obtain multiple items from the result object, first, determine the number of items contained in the object using the PrlResult_GetParamsCount function. Then, iterate through the list and use the iteration number as the value of the nIndex parameter.

Links

PHT_RESULT