<div class="content" name="FaxObs_GetRoutingInfo" uuid="f92cd5fb-de4c-4242-9929-f1b6bfd34efe"><p>The <b>FaxObs_GetRoutingInfo (Opnum 18)</b> method is called
by the client to retrieve information about a routing method.</p><p>The client MUST set the <i>FaxPortHandle</i> parameter to a
valid fax port handle value returned by the <b>FaxObs_OpenPort</b> (section
<a href="2c8a37ec-7c13-4a2c-93b7-cf19534846c2" data-linktype="relative-path">3.1.4.2.5</a>) method.</p><p>The server MUST validate that the client&#39;s fax user account
has access to retrieve information about a routing method. The server MUST
validate that the <i>RoutingGuid</i> parameter is for a valid routing method.
On success, the server MUST return the routing information for a fax routing
method that is associated with the specified fax port (device) in the <i>RoutingInfoBuffer</i>
parameter.</p><p>The client SHOULD free the returned buffer.</p><dl>
<dd>
<div><pre> error_status_t FaxObs_GetRoutingInfo(
   [in] RPC_FAX_PORT_HANDLE FaxPortHandle,
   [in, string, unique] LPCWSTR RoutingGuid,
   [in, out, unique, size_is(,*RoutingInfoBufferSize)] 
     LPBYTE* RoutingInfoBuffer,
   [in, out] LPDWORD RoutingInfoBufferSize
 );
</pre></div>
</dd></dl><p><b>FaxPortHandle: </b>An <a href="46aba9c4-ebb1-4b10-86ac-4bb3025657b9#gt_9dfe84e3-a772-4ad1-9a25-1255c1dc0f84" data-linktype="relative-path">RPC context handle</a> that
references a specified fax port.</p><p><b>RoutingGuid: </b>A curly braced <a href="46aba9c4-ebb1-4b10-86ac-4bb3025657b9#gt_f49694cc-c350-462d-ab8e-816f0103c6c1" data-linktype="relative-path">GUID</a> string that uniquely
identifies the fax routing method for which to obtain the routing information.
Fax routing methods are defined by a fax-routing extension and each method is
identified by a GUID. For more information about routing methods, see <a href="https://go.microsoft.com/fwlink/?LinkId=90010" data-linktype="external">[MSDN-FRM]</a>. The
routing methods and their curly braced GUID string values that can be used for
this parameter are discoverable by calling <b>FaxObs_EnumRoutingMethods</b> (section
<a href="0b782aca-117e-4384-a873-291dd86a623f" data-linktype="relative-path">3.1.4.2.18</a>). Included
in this list are the default routing methods described in section <a href="89220226-b68e-4d97-96ef-ce622145ecfa" data-linktype="relative-path">2.2.87</a>.</p><p><b>RoutingInfoBuffer: </b>A pointer to the address of
the returned buffer containing the fax-routing information. The buffer format
and contents depend on the routing method that is identified by <i>RoutingGuid</i>.</p><p><b>RoutingInfoBufferSize: </b>A pointer to a <b>DWORD</b>
(<a href="../ms-dtyp/cca27429-5689-4a16-b2b4-9325d93e4ba2" data-linktype="relative-path">[MS-DTYP]</a>
section <a href="../ms-dtyp/262627d8-3418-4627-9218-4ffe110850b2" data-linktype="relative-path">2.2.9</a>)
variable that receives the size, in bytes, of the <i>RoutingInfoBuffer</i>
buffer.</p><p><b>Return Values: </b>This method MUST return
0x00000000 (ERROR_SUCCESS) for success; otherwise, it MUST return one of the
following error codes, one of the fax-specific errors that are defined in
section <a href="cbe6c4fb-4dda-4f6c-9701-0d490ba0d105" data-linktype="relative-path">2.2.52</a>, or one
of the other standard errors defined in <a href="../ms-erref/1bc92ddf-b79e-413c-bbaa-99a5281a6c90" data-linktype="relative-path">[MS-ERREF]</a>
section <a href="../ms-erref/18d8fbe8-a967-4f1c-ae50-99ca8e491d2d" data-linktype="relative-path">2.2</a>.</p><dl>
<dd>
<table><thead>
  <tr>
   <th>
   <p>Return value/code</p>
   </th>
   <th>
   <p>Description</p>
   </th>
  </tr>
 </thead><tbody><tr>
  <td>ERROR_ACCESS_DENIED 0x00000005</td>
  <td>Access is denied. The client&#39;s fax user account does not have the FAX_PORT_QUERY access rights.</td>
 </tr><tr>
  <td>ERROR_NOT_ENOUGH_MEMORY 0x00000008</td>
  <td>The fax server cannot allocate sufficient memory for the data to be returned to the client.</td>
 </tr><tr>
  <td>ERROR_INVALID_DATA 0x0000000D</td>
  <td>The data is invalid. This error code is returned when any of the following conditions are met: § The FaxPortHandle argument is not a valid handle obtained using FaxObs_OpenPort.&lt;205&gt; § The GUID specified by the RoutingGuid parameter is not a routing method GUID.</td>
 </tr><tr>
  <td>ERROR_INVALID_PARAMETER 0x00000057</td>
  <td>The parameter is incorrect. One or more of the following parameters are set to NULL pointer values: RoutingGuid, RoutingInfoBuffer, RoutingInfoBufferSize.&lt;206&gt;</td>
 </tr></tbody></table>
</dd></dl><p><b>Exceptions Thrown:</b> No exceptions are thrown
except those that are thrown by the underlying <a href="46aba9c4-ebb1-4b10-86ac-4bb3025657b9#gt_8a7f6700-8311-45bc-af10-82e10accd331" data-linktype="relative-path">RPC</a> protocol, <a href="../ms-rpce/290c38b1-92fe-4229-91e6-4fc376610c15" data-linktype="relative-path">[MS-RPCE]</a>.</p></div>