GetAliasName Function

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

Syntax

GetAliasName(
    ITABLESET_HANDLE i_hITableSet, 
    int i_iIndex,
    unsigned short* io_aliasNameSize,
    Char* o_aliasName)

    Parameters

i_hITableSet [In]

The handle to the ITableSet interface. See hITableSet Variable.

i_iIndex [In]

The table's index number.

io_aliasNameSize [In, Out]

The size of your buffer.

o_aliasName [Out]

The name of the alias.

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.

Remarks

An alias is a string that serves as a unique identifier for a table. The name of the alias does not change, even if you change the name or location of the database. The alias name is especially useful for ensuring that selection formulas can be executed properly. For example, if a formula uses a table that has been renamed or moved, then the alias can be used to find the table's new name or location.