3.1.4.38 RRPC_FWQueryFirewallRules (Opnum 37)

The RRPC_FWQueryFirewallRules (Opnum 37) method requests the server to return all the firewall rules that match the specified query object that are contained in the store referenced by the hPolicy handle. The method returns a linked list of all the firewall rule objects. The only method supported is binary version 0x020A.

 unsigned long RRPC_FWQueryFirewallRules(
   [in] FW_CONN_HANDLE rpcConnHandle,
   [in] FW_POLICY_STORE_HANDLE hPolicy,
   [in] PFW_QUERY pQuery,
   [in] unsigned short wFlags,
   [out, ref] unsigned long* pdwNumRules,
   [out] PFW_RULE2_10* ppRule
 );

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.

pQuery: This parameter represents the query object that the client uses to specify which main mode rules MUST be retrieved from the store. The query object MUST be valid, as specified in the definition of the FW_QUERY data type.

wFlags: This parameter is a combination of flags from the FW_ENUM_RULES_FLAGS enumeration, which modifies the behavior of the method and performs operations on the rules before returning them in the linked list.

pdwNumRules: This is an output parameter that on success MUST be equal to the number of rules returned.

ppRule: This is an output parameter that on success contains a linked list of FW_RULE2_10 data types.

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.
0x00000057 ERROR_INVALID_PARAMETER	One of the parameters of this method is incorrect, or is required but not specified. This error can be returned in the following cases: - One of the parameters did not meet the required constraints. - The pQuery parameter contains invalid profiles.

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.