Sm_PolicyApi_GetODBCQuerySchemeByName()

Gets the contents of the ODBC Query Scheme object identified by pszODBCQuerySchemeName.
casso10
Gets the contents of the ODBC Query Scheme object identified by
pszODBCQuerySchemeName
.
The results of this function are returned in a structure referenced by
pstructODBCQueryScheme
. Free the memory allocated for this structure calling Sm_PolicyApi_FreeMemoryEx().
Type
ODBC query scheme function, global scope.
Syntax
int SM_EXTERN Sm_PolicyApi_GetODBCQuerySchemeByName (
void*pSessionHandle,
const char*pszODBCQuerySchemeName,
Sm_PolicyApi_ODBCQueryScheme_t**pstructODBCQueryScheme
);
Parameter
I/O
Description
pSessionHandle
I
A pointer to an internal Policy Management API data structure. The structure holds information about the administrator session and the client session.
pszODBCQuerySchemeName
I
A null-terminated string containing the name of an existing ODBC Query Scheme.
pstructODBCQueryScheme
O
The address of a pointer to a ODBC query scheme.
Returns
  • Sm_PolicyApi_Success. The get operation was successful.
  • Sm_PolicyApi_Failure. Memory could not be allocated for Sm_PolicyApi_ODBCQueryScheme_t.
  • Sm_PolicyApi_InvalidHandle. There was no valid initialization prior to this call.
  • Sm_PolicyApi_NoSession. There is no valid administrator session.
  • Sm_PolicyApi_NoPrivilege. The administrator does not have the privilege to get an ODBC Query Scheme.
  • Sm_PolicyApi_NotFound. The ODBC Query Scheme name was not found.