Sm_PolicyApi_GetRealm()
Gets the contents of the realm identified by pszRealmOid.
sm1252sp1
Gets the contents of the realm identified by
pszRealmOid
.The results of this function are returned in a structure referenced by
ppstructRealm
. Free the memory allocated for this structure by calling Sm_PolicyApi_FreeMemoryEx().Type
Realm function, domain scope.
Syntax
int SM_EXTERN Sm_PolicyApi_GetRealm (void*pSessionHandle,const char*pszRealmOid, Sm_PolicyApi_Realm_t**ppstructRealm);
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. |
pszRealmOid
| I | A null-terminated string containing the object identifier of an existing realm. |
ppstructRealm
| O | The address of a pointer to a realm structure. |
Returns
- Sm_PolicyApi_Success. The get operation was successful.
- Sm_PolicyApi_Failure. Memory could not be allocated for Sm_PolicyApi_Realm_t.
- Sm_PolicyApi_NoSession. There is no valid administrator session.
- Sm_PolicyApi_InvalidHandle. There was no valid initialization prior to this call.
- Sm_PolicyApi_NoPrivilege. The administrator does not have the privilege to get a realm.
- Sm_PolicyApi_InvalidOid. The realm OID was not found.