GetTableName Function

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

Syntax

GetTableName(
    ITABLESET_HANDLE i_hITableSet, 
    int i_iIndex,
    unsigned short* io_tableNameSize,
    Char* o_tableName)

    Parameters

i_hITableSet [In]

The handle to the ITableSet interface. See hITableSet Variable.

i_iIndex [In]

The table's index number.

io_tableNameSize [In, Out]

The size of your buffer.

o_tableName [Out]

The name of the table.

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.