<div class="content"><p>The <b>RRouterInterfaceGetHandle</b> method<a id="Appendix_A_Target_260"></a><a aria-label="Product behavior note 260" href="3bb906f0-b077-47ab-ad11-d8d807afde26#Appendix_A_260" data-linktype="relative-path">&lt;260&gt;</a> retrieves the handle of the
specified interface <i>lpwsInterfaceName</i> among all the
ROUTER_INTERFACE_TYPEs. The <i>hDimServer</i> handle determines the RRAS server
on which the call is made.</p><dl>
<dd>
<div><pre> DWORD RRouterInterfaceGetHandle(
   [in] DIM_HANDLE hDimServer,
   [in, string] LPWSTR lpwsInterfaceName,
   [in, out] LPDWORD phInterface,
   [in] DWORD fIncludeClientInterfaces
 );
</pre></div>
</dd></dl><p><b>hDimServer: </b>A handle to the RRAS server where
the call is executed, see section <a href="1f8cdbcc-9791-4a35-ad78-878b8d110e15" data-linktype="relative-path">3.1.3</a>.</p><p><b>lpwsInterfaceName: </b>Pointer to a
null-terminated Unicode string that specifies the name of the interface to be
retrieved.</p><p><b>phInterface: </b>This is a pointer to a <b>DWORD</b>
that receives the unique identifier of the interface specified by <i>lpwsInterfaceName</i>.</p><p><b>fIncludeClientInterfaces: </b>Specifies whether
the method includes client interfaces while searching. If this parameter is 0,
interfaces of type ROUTER_IF_TYPE_CLIENT are ignored in the search for the
interface with the name specified by <i>lpwsInterfaceName</i>. If this
parameter is a nonzero value and an interface with the specified name exists, <b>RRouterInterfaceGetHandle</b>
returns a handle to an interface of type ROUTER_IF_TYPE_CLIENT. Since it is
possible that there are several interfaces of type ROUTER_IF_TYPE_CLIENT, the
handle returned references the first interface that is found with the name
ROUTER_IF_TYPE_CLIENT specified by <i>lpwsInterfaceName</i>.</p><p><b>Return Values: </b>A 32-bit, unsigned integer
value that indicates return status. A return value of ERROR_SUCCESS (0x00000000)
indicates that the operation was completed successfully; otherwise it contains
an error code, as specified in <a href="../ms-erref/1bc92ddf-b79e-413c-bbaa-99a5281a6c90" data-linktype="relative-path">[MS-ERREF]</a>
or in section <a href="5c0c991a-0d3d-4fe5-9503-5128d0d49fe1" data-linktype="relative-path">2.2.4</a>.
All values that are not in the table that follows MUST be treated the same by
the RRASM client.</p><dl>
<dd>
<table><thead>
  <tr>
   <th>
   <p>Return value/code</p>
   </th>
   <th>
   <p>Description</p>
   </th>
  </tr>
 </thead><tbody><tr>
  <td>
  <p>ERROR_SUCCESS</p>
  <p>0x00000000</p>
  </td>
  <td>
  <p>The call was successful.</p>
  </td>
 </tr><tr>
  <td>
  <p>ERROR_ACCESS_DENIED</p>
  <p>0x00000005</p>
  </td>
  <td>
  <p>The calling application does not have sufficient
  privileges, as specified in section <a href="9373431f-ed29-4639-9f8b-743267c9f9b6" data-linktype="relative-path">2.1.1.1</a>.</p>
  </td>
 </tr></tbody></table>
</dd></dl><p>The opnum field value for this method is 11.</p><p>When processing this call, the RRASM server MUST do the
following:</p><ul><li><p><span><span> 
</span></span>Validate, as specified in section 2.1.1.1, whether this method
was called by a client that has access to the method. If the client does not
have access, then return error ERROR_ACCESS_DENIED (0x00000005).</p>
</li><li><p><span><span> 
</span></span>If <i>lpwsInterfaceName</i> is NULL, return an error other than
those specified in the preceding table.</p>
</li><li><p><span><span> 
</span></span>If the interface name of any entry in InterfaceList is not the
same as <i>lpwsInterfaceName</i>, return an error other than one of the errors
specified in the preceding table.</p>
</li><li><p><span><span> 
</span></span>Call the abstract interface <b>Invoke DIMSVC</b> method
specifying the operation and the parameters to enable RRAS server to perform
the required management task.</p>
</li><li><p><span><span> 
</span></span>If the RRAS server has successfully processed the request,
populate the interface handle in <i>phInterface</i>. This interface handle is
the same as the one present as a part of the interface-specific entry in
InterfaceList. Return ERROR_SUCCESS.</p>
</li><li><p><span><span> 
</span></span>Otherwise return the error provided by the RRAS server.</p>
</li></ul><p>No exceptions are thrown beyond those thrown by the
underlying RPC protocol <a href="../ms-rpce/290c38b1-92fe-4229-91e6-4fc376610c15" data-linktype="relative-path">[MS-RPCE]</a>.</p></div>