Component:

S_Set_Alias

part of C_WissDB_DL_API

Abstract:

This is the function by which you can define or change the value of an Alias N representing a Project Locator that may or may not be currently in use.

Use S_Get_Alias in order to see the current value of N. Other services are to show standard locators (because these are the values of A_Loc attributes).

Parameters:

§      In: Alias

        Is to be a positive integer.

§      In: LocatorName

        Is to be NULL or a D_Locator of type Project Locator that may or may not start with the alias of another project locator.

§      Out: AppErrors

        Is to describe an AppError if the given LocatorName does not have the form of a Project Locator, is starting with an alias that has value NULL, or is not NULL though the Alias is currently not prefix of a locator in use.

§      Out: ReturnCode is one of the following values:

–      RC_ok

–      RC_syserror

–      RC_seeAppErrors

Has to:

The B_WissDB_Database has assigned to each positive number either NULL or a value of type D_Locator not starting with a number. From now on LocatorName is to be this value.

Because of:

Applications of C_WissDB_DL_API need a way to re-configure the value of a project locator alias.