GetName Function

Retrieves the name of a prompt currently being used in the report being processed.

Syntax

GetName(
    IPROMPTSET_HANDLE i_hIPromptSet, 
    int i_iIndex,
    unsigned short* io_nameSize,
    Char* o_name)

    Parameters

i_hIPromptSet [In]

The handle to the IPromptSet interface. See hIPromptSet Variable.

i_iIndex [In]

The prompt's index number.

io_nameSize [In, Out]

The size of your buffer.

o_name [Out]

The name of the prompt.

Returns

Each function returns a RET_VALUE that is an error code of type Long. The return value is greater than zero if the call was successful, and zero or less if not. Use RET_OK(x) and RET_ERROR(x) to check for failure.

If the function call fails, check the value of the buffer size parameter. After a successful function call, this parameter contains the size of the buffer that you passed in. However, if the buffer size is too small, then the function returns PROCESSEXTERR_BUFFERSIZETOOSMALL, and the buffer size that is needed is specified in the parameter.