FSUMPluginInit function (C programming language)

FSUMPluginInit is the initialization function for the user mapping plug-in.

This function performs these tasks:
  • Passes the pointers for the four other required functions to the federated server.
  • Obtains utility functions that the federated server passes.
  • Sets up global resources at the plug-in level.

Syntax

SQL_API_RC SQL_API_FN FSUMPluginInit
	(sqlint32 a_version,
	FSUMPluginAPIs* a_pluginAPIs,
	FSUMPluginUtilities* a_pluginUtils);

Inputs

sqlint32 a_version
The version number of the user mapping plug-in interface.
FSUMPluginUtilities *a_pluginUtils
The pointer to the structure that contains all the utility functions. The plug-in obtains a pointer to each utility function, as needed.

Outputs

FSUMPluginAPIs *a_pluginAPIs
The plug-in uses this structure to pass the function pointers for FSUMconnect, FSUMfetchUM, FSUMdisconnect, and FSUMPluginTerm to the federated server.