Sm_PolicyApi_DeleteRule()

Deletes the rule identified by pszRuleOid.

Type

Rule function, domain scope.

Syntax

int SM_EXTERN Sm_PolicyApi_DeleteRule (
   void*          pSessionHandle,
   const char*    pszRuleOid
);

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.
pszRuleOid	I	A null-terminated string containing the object identifier of an existing rule.

Returns

Sm_PolicyApi_Success. The rule was deleted successfully.
Sm_PolicyApi_Failure. The rule was not deleted successfully.
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 delete a rule.
Sm_PolicyApi_InvalidOid. The rule OID was not found.