<div class="content" name="FAX_GetPort" uuid="f7fa6fcf-ace1-47a2-b2a4-f5e408212d78"><p>The <b>FAX_GetPort (Opnum 11)</b> method is called by the
client to retrieve port status information for a requested port at the server.</p><p>The server MUST validate that the user has the access to get
port status information. The <i>PortBuffer</i> parameter MUST NOT be <b>NULL</b>.
The <i>FaxPortHandle</i> parameter MUST be returned by the <b>Fax_OpenPort</b> (section
<a href="aca2b58a-e310-42dc-9903-18c5b6c35797" data-linktype="relative-path">3.1.4.1.65</a>) method
called by the client with the PORT_OPEN_QUERY port access mode flag specified
with the <i>Flags</i> argument. On success, the server MUST return information
for a specified fax port to a fax client application in <i>PortBuffer</i>.<a id="Appendix_A_Target_123"></a><a aria-label="Product behavior note 123" href="056171e7-80bc-45ff-8107-66ba3abb2023#Appendix_A_123" data-linktype="relative-path">&lt;123&gt;</a> </p><p>The client SHOULD free the returned buffer.</p><dl>
<dd>
<div><pre> error_status_t FAX_GetPort(
   [in] RPC_FAX_PORT_HANDLE FaxPortHandle,
   [out, size_is(,*BufferSize)] LPBYTE* PortBuffer,
   [out, ref] LPDWORD BufferSize
 );
</pre></div>
</dd></dl><p><b>FaxPortHandle: </b>An <a href="46aba9c4-ebb1-4b10-86ac-4bb3025657b9#gt_8a7f6700-8311-45bc-af10-82e10accd331" data-linktype="relative-path">RPC</a> context handle that
references a specified fax port.</p><p><b>PortBuffer: </b>A pointer to the address of a
buffer to receive a <b>_FAX_PORT_INFO</b> (section <a href="ed920746-d222-4e0a-a75d-905f26cf1dfc" data-linktype="relative-path">2.2.8</a>) structure. The
structure describes one fax port.</p><p><b>BufferSize: </b>A variable to return the size, in
bytes, of the port 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_ACCESS_QUERY_CONFIG access rights required for this operation.</td>
 </tr><tr>
  <td>ERROR_NOT_ENOUGH_MEMORY 0x00000008</td>
  <td>The server cannot allocate sufficient memory to hold the FAX_PORT_INFO (section 2.2.7) data structure to be returned to the client.</td>
 </tr><tr>
  <td>ERROR_INVALID_DATA 0x0000000D</td>
  <td>The FaxPortHandle parameter is not set to a valid port handle obtained using FAX_OpenPort.&lt;124&gt;</td>
 </tr><tr>
  <td>ERROR_INVALID_PARAMETER 0x00000057</td>
  <td>The parameter is incorrect. This error code is returned if any of the following conditions are met: § The PortBuffer parameter is set to a NULL pointer value.&lt;125&gt; § The FaxPortHandle parameter is set to NULL.&lt;126&gt;</td>
 </tr><tr>
  <td>ERROR_INTERNAL_ERROR 0x0000054F</td>
  <td>The server failed to custom marshal the FAX_PORT_INFO to be returned to the client.</td>
 </tr></tbody></table>
</dd></dl><p><b>Exceptions Thrown:</b> No exceptions are thrown
except those that are thrown by the underlying RPC protocol, <a href="../ms-rpce/290c38b1-92fe-4229-91e6-4fc376610c15" data-linktype="relative-path">[MS-RPCE]</a>.</p></div>