<div class="content" name="FAX_GetMessage" uuid="a083e60d-b9c0-42b8-923a-d246506bd509"><p>The <b>FAX_GetMessage (Opnum 66)</b> method is called by the
client. The <a href="46aba9c4-ebb1-4b10-86ac-4bb3025657b9#gt_9394bf31-7db9-433c-8d3d-ee6a37bf0848" data-linktype="relative-path">archive</a> can
be one of the enumerations that are defined by <b>FAX_ENUM_MESSAGE_FOLDER</b>
(section <a href="1c7a6f3f-1e5b-40a2-bc48-0729f3a6cf0d" data-linktype="relative-path">2.2.2</a>) except
FAX_MESSAGE_FOLDER_QUEUE. The <i>dwlMessageId</i> parameter specifies a
particular message and can be obtained using the <b>FAX_EnumMessages</b> (section
<a href="365c2295-c0f9-44bd-a72b-6db0b16c0f8f" data-linktype="relative-path">3.1.4.1.24</a>) method or
the <b>FAX_EnumMessagesEx</b> (section <a href="43cf8eed-1cf3-4240-80c5-6f8d1d082084" data-linktype="relative-path">3.1.4.1.25</a>) method.</p><p>In response, the server MUST validate that the message ID is
for a valid message. The server MUST validate that the client&#39;s fax user
account has access to read the message.</p><p>On success, the server MUST return the contents of the
message and also its size.</p><p>The client SHOULD free the returned buffer.</p><dl>
<dd>
<div><pre> error_status_t FAX_GetMessage(
   [in] handle_t hFaxHandle,
   [in] DWORDLONG dwlMessageId,
   [in] FAX_ENUM_MESSAGE_FOLDER Folder,
   [out, size_is(, *lpdwBufferSize)] 
     LPBYTE* lppBuffer,
   [out, ref] LPDWORD lpdwBufferSize
 );
</pre></div>
</dd></dl><p><b>hFaxHandle: </b>The RPC binding handle for this
call. The client SHOULD reuse the RPC binding handle used as an input <i>hBinding</i>
argument for the <b>FAX_ConnectFaxServer</b> (section <a href="5cbfd38d-7a14-4560-ad24-9ed78f19a3bb" data-linktype="relative-path">3.1.4.1.10</a>) or <b>FAX_ConnectionRefCount</b> (section
<a href="a92941ac-bd07-4a71-af85-c2c157c97cf9" data-linktype="relative-path">3.1.4.1.11</a>) method call
used to connect to the fax server.</p><p><b>dwlMessageId: </b>A <b>DWORDLONG</b> (<a href="../ms-dtyp/cca27429-5689-4a16-b2b4-9325d93e4ba2" data-linktype="relative-path">[MS-DTYP]</a>
section <a href="../ms-dtyp/c575fb47-166c-48cd-a37c-e44cac05c3d6" data-linktype="relative-path">2.2.13</a>)
value that identifies the fax message to retrieve from the archive.</p><p><b>Folder: </b>The type of archive where the message
resides. FAX_MESSAGE_FOLDER_QUEUE is an invalid value for this parameter.</p><p><b>lppBuffer: </b>A pointer to a buffer that receives
a <b>FAX_MESSAGEW</b> (section <a href="998ba0cc-549e-41f4-b415-20fd55a10013" data-linktype="relative-path">2.2.38</a>) structure. This
buffer contains the retrieved message.</p><p><b>lpdwBufferSize: </b>A pointer to a <b>DWORD</b>
([MS-DTYP] section <a href="../ms-dtyp/262627d8-3418-4627-9218-4ffe110850b2" data-linktype="relative-path">2.2.9</a>)
in which to return the size, in bytes, of the buffer that is pointed to by the <i>lppBuffer</i>
parameter.</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 any of the permissions covered by ALL_FAX_USER_ACCESS_RIGHTS (section 2.2.83).</td>
 </tr><tr>
  <td>ERROR_NOT_ENOUGH_MEMORY 0x00000008</td>
  <td>Not enough storage is available to process this command. The fax server failed to allocate sufficient memory to hold the FAX_MESSAGEW to be returned to the client.</td>
 </tr><tr>
  <td>ERROR_INVALID_PARAMETER 0x00000057</td>
  <td>The parameter is incorrect. This error code is returned when any of the following conditions are met: § The lppBuffer or lpdwBufferSize parameters are set to NULL pointer values.&lt;116&gt; § The dwlMessageId parameter is set to a value of 0, and the value of the specified Folder parameter is not FAX_MESSAGE_FOLDER_INBOX or FAX_MESSAGE_FOLDER_SENTITEMS.</td>
 </tr><tr>
  <td>ERROR_INTERNAL_ERROR 0x0000054F</td>
  <td>The fax server failed to custom marshal the FAX_MESSAGEW to be returned to the client.</td>
 </tr><tr>
  <td>FAX_ERR_MESSAGE_NOT_FOUND 0x00001B61</td>
  <td>The fax server cannot find the job or message by its identifier.  This error code is returned when any of the following conditions are met: § The message identified by dwlMessageId is not found. § The message identified by dwlMessageId is an unassigned incoming fax. The incoming faxes are not public (accessible to all users), and the user does not have FAX_ACCESS_MANAGE_RECEIVE_FOLDER permission. § The message identified by dwlMessageId is for a different user, and this user does not have FAX_ACCESS_QUERY_ARCHIVES permission.</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>