<div class="content" name="RRPC_FWQueryCryptoSets" uuid="3dc9e91d-d0ee-4e1c-a30d-70c89052de84"><p>The RRPC_FWQueryCryptoSets (Opnum 41) method requests the
server to return all the crypto sets that match the specified query object that
are contained in the store referenced by the <i>hPolicy</i> handle. The method
returns a linked list of all the crypto set objects. The only method supported
is binary version 0x020A.</p><dl>
<dd>
<div><pre> unsigned long RRPC_FWQueryCryptoSets(
   [in] FW_CONN_HANDLE rpcConnHandle,
   [in] FW_POLICY_STORE_HANDLE hPolicy,
   [in, range(FW_IPSEC_PHASE_INVALID+1, FW_IPSEC_PHASE_MAX-1)] 
     FW_IPSEC_PHASE IPsecPhase,
   [in] PFW_QUERY pQuery,
   [in] unsigned short wFlags,
   [out, ref] unsigned long* pdwNumSets,
   [out] PFW_CRYPTO_SET* ppCryptoSets
 );
</pre></div>
</dd></dl><p><b>rpcConnHandle: </b>This parameter is an <span><a href="d891304d-92d8-4f9f-9e60-a1f02b28ae30#gt_8a7f6700-8311-45bc-af10-82e10accd331" data-linktype="relative-path">RPC</a></span>
binding handle that connects to the RPC interface of the Firewall and Advanced
Security Protocol.</p><p><b>hPolicy: </b>This input parameter is an <span><a href="88f6ea4a-a946-4747-bb93-f142f1760752" data-linktype="relative-path">FW_POLICY_STORE_HANDLE</a></span>
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 <span><a href="37ebed95-8abf-472c-8b4b-7a510a2a6baa" data-linktype="relative-path">FW_STORE_TYPE_DYNAMIC</a></span>
store.</p><p><b>IPsecPhase: </b>This parameter specifies the
specific <span><a href="d891304d-92d8-4f9f-9e60-a1f02b28ae30#gt_f8a5b7f0-25e0-4c81-9abf-00b56a580deb" data-linktype="relative-path">IPsec</a></span> negotiation
phase to which this set applies.</p><p><b>pQuery: </b>This parameter represents the query
object that the client wants to use 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 <span><a href="51b69145-317a-4368-a6e5-7159e946ff14" data-linktype="relative-path">FW_QUERY</a></span> data type.</p><p><b>wFlags: </b>This parameter is a combination of
flags from the <span><a href="aff3633c-43b2-4cef-ba63-f35b204a8a08" data-linktype="relative-path">FW_ENUM_RULES_FLAGS</a></span>
enumeration, which modifies the behavior of the method and performs operations
on the rules before returning them in the linked list.</p><p><b>pdwNumSets: </b>This is an output parameter that,
on success, MUST be equal to the number of sets returned.</p><p><b>ppCryptoSets: </b>This is an output parameter
that, on success, contains a linked list of <span><a href="a468fe9e-113b-4155-a63d-0db3aac12619" data-linktype="relative-path">FW_CRYPTO_SET</a></span> data
types.</p><p><b>Return Values: </b>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 <span><a href="../ms-erref/1bc92ddf-b79e-413c-bbaa-99a5281a6c90" data-linktype="relative-path">[MS-ERREF]</a></span>.
The following return values are common.</p><dl>
<dd>
<table><thead>
  <tr>
   <th>
   <p>Return value/code</p>
   </th>
   <th>
   <p>Description</p>
   </th>
  </tr>
 </thead><tbody><tr>
  <td>0x00000005 ERROR_ACCESS_DENIED</td>
  <td>The client does not have the required credentials to call the method.</td>
 </tr><tr>
  <td>0x00000057 ERROR_INVALID_PARAMETER</td>
  <td>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.</td>
 </tr></tbody></table>
</dd></dl><p><b>Exceptions Thrown:</b> No exceptions are thrown
beyond those thrown by the underlying RPC protocol, as specified in <span><a href="../ms-rpce/290c38b1-92fe-4229-91e6-4fc376610c15" data-linktype="relative-path">[MS-RPCE]</a></span>.
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.</p><p>The server MUST validate that the client is authorized to
perform the requested operation (as defined in section <span><a href="b0c93352-8371-4d63-abca-b0cc8dbcc3d7" data-linktype="relative-path">3.1.4</a></span>)
before executing this method.</p></div>