The FUNCTIONS schema rowset returns metadata that indicates which fuctions are available on the cubes that can be accessed by the provider. Each row in the FUNCTIONS schema rowset corresponds to one function that is available in the provider. The default sort order is ORIGIN, INTERFACE_NAME, and FUNCTION_NAME.
The following table describes the columns that are available in the FUNCTIONS schema rowset.
Column Name | Type Indicator | Mapped Value | Restrictions Supported? |
---|---|---|---|
FUNCTION_NAME | DBTYPE_WSTR | Name of the function. | Yes |
DESCRIPTION | DBTYPE_WSTR | Description of the function. | No |
PARAM_LIST | DBTYPE_WSTR | Comma-delimited list of parameters. | No |
RETURN_TYPE | DBTYPE_14 | Variable type of the return data type of the function. | No |
ORIGIN | DBTYPE_14 | One of the following:
|
Yes |
INTERFACE_NAME | DBTYPE_WSTR | Name of the interface for the user-defined function, as well as the group name for the MDX functions. | Yes |
LIBRARY_NAME | DBTYPE_WSTR | Name of the type library for user-defined functions. | Yes |
DLL_NAME | DBTYPE_WSTR | Name of the .dll or .exe in which this function is implemented. | No |
HELP_FILE | DBTYPE_WSTR | Name of the help file that documents this function. | No |
HELP_CONTEXT | DBTYPE_14 | Help context ID for this function in the help file. | No |
OBJECT | DBTYPE_WSTR | Object to which this function applies such as a dimension or level. | No |
Restrictions enable an OLE DB consumer to restrict the rows that are returned in a schema rowset by IDBSchemaRowset::GetRowset. A restriction is a value for a specific column. When a restriction is passed to IDBSchemaRowset::GetRowset, all rows that are returned in the schema rowset must match the restriction value on the specified column. Restriction values do not support pattern matching or wildcards. For example, the restriction value D_F matches D_F but not DEF.
Note: For definitions of the type indicators, see "Type Indicators" in Microsoft's OLE DB specification documentation.