FSUMfetchUM function (C programming language)
The federated server calls the FSUMfetchUM function to retrieve user mapping options from an external repository.
Each user mapping entry is identified by the federated instance name (fsInstanceName), database name (fsDatabaseName), remote server name (fsServerName), and the local user's authorization ID (fsAuthID). The user mapping can also include the REMOTE_AUTHID and REMOTE_PASSWORD options, which the plug-in retrieves.
Syntax
SQL_API_RC SQL_API_FN FSUMfetchUM (void* a_FSUMRepository,
FSUMEntry* a_entry);Inputs
- void* a_FSUMRepository
- The connection handle to the external repository. This handle must be cast to the real structure that is defined in the plug-in.
- FSUMEntry* a_entry
- This parameter is both an input parameter and an output parameter.
As an input, this parameter passes the information that is required to identify the user mapping entry in the user mapping repository. This information includes fsInstanceName, fsDatabaseName, fsServerName, and fsAuthID.
As an output, the user mapping options that are retrieved from the user mapping repository are added to this parameter. The plug-in must use the FSUMaddUMOption utility function to add an option to the user mapping entry, a_entry. If the user mapping includes the REMOTE_PASSWORD option and if the password is encrypted, the plug-in must decrypt the password before calling the FSUMaddUMOption. The federated server is not responsible for freeing the storage for the strings that are passed to the FSUMaddUMoption function.