Share via

3.1.4.35 RRPC_FWDeleteMainModeRule (Opnum 34)

  • Article

The RRPC_FWDeleteMainModeRule (Opnum 34) method requests the server to delete the specified main mode rule in the policy contained in the policy store referenced by the handle specified in the hPolicy parameter. The only method supported is binary version 0x020A.

 unsigned long RRPC_FWDeleteMainModeRule(
   [in] FW_CONN_HANDLE rpcConnHandle,
   [in] FW_POLICY_STORE_HANDLE hPolicy,
   [in, string, ref] LPCWSTR pRuleId
 );

rpcConnHandle: This parameter is an RPC binding handle that connects to the RPC interface of the Firewall and Advanced Security Protocol.

hPolicy: This input parameter is an FW_POLICY_STORE_HANDLE data type. The data type MUST contain an opened policy store handle, successfully opened with the RRPC_FWOpenPolicyStore (Opnum 0) method. This handle MUST be of the FW_STORE_TYPE_DYNAMIC store.

pRuleId: This parameter is the pointer to a STRING that is the ID of the main mode rule the client deletes from the specified store.

This ID can be obtained by enumerating main mode rules using the RRPC_FWEnumMainModeRules(Opnum 36) where the ID is returned in the FW_MM_RULE structure.

Return Values: The method returns 0 if successful; if it fails, it returns a nonzero error code. The field can take any specific error code value, as specified in [MS-ERREF]. The following return values are common.

Return value/code

Description

0x00000005

ERROR_ACCESS_DENIED

The client does not have the required credentials to call the method.

0x00000002

ERROR_FILE_NOT_FOUND

The specified set referenced by the wszRuleID member string of the FW_MM_RULE data type is not found in the policy store.

0x00000057

ERROR_INVALID_PARAMETER

One of the parameters of this method either is incorrect, or is required and not specified.

Exceptions Thrown: No exceptions are thrown beyond those thrown by the underlying RPC protocol, as specified in [MS-RPCE]. If any lower-layer errors are reported by RPC exception, this exception is converted to an error code and reported to higher-layer protocols via the return value.

The server MUST validate that the client is authorized to perform the requested operation (as defined in section 3.1.4) before executing this method.