Sm_PolicyApi_GetDomain()

Gets the contents of the domain identified by pszDomainOid. The results of this function are returned in a structure referenced by ppstructDomain.
casso127
Gets the contents of the domain identified by
pszDomainOid
. The results of this function are returned in a structure referenced by
ppstructDomain
.
Free the memory allocated for this structure by calling Sm_PolicyApi_FreeMemoryEx().
Type
Domain function, global scope.
Syntax
int SM_EXTERN Sm_PolicyApi_GetDomain (
void*pSessionHandle,
const char*pszDomainOid,
Sm_PolicyApi_Domain_t**ppstructDomain
);
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.
pszDomainOid
I
A null-terminated string containing the object identifier of an existing domain.
ppstructDomain
O
The address of a pointer to a domain structure.
Returns
  • Sm_PolicyApi_Success. The get operation was successful.
  • Sm_PolicyApi_Failure. Memory could not be allocated for Sm_PolicyApi_Domain_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 a domain.
  • Sm_PolicyApi_InvalidOid. The domain OID was not found.