<div class="content" name="FAX_GetArchiveConfiguration" uuid="332f9426-d35b-43e5-9251-bf50b7de459c"><p>The <b>FAX_GetArchiveConfiguration (Opnum 41)</b> method is
called by the client to retrieve the current <a href="46aba9c4-ebb1-4b10-86ac-4bb3025657b9#gt_9394bf31-7db9-433c-8d3d-ee6a37bf0848" data-linktype="relative-path">archive</a> configuration on
the fax server. In response, the server returns archive configuration
information about the fax server.</p><p>Protocol version FAX_API_VERSION_3 (0x00030000) fax servers
SHOULD fail this call by returning ERROR_NOT_SUPPORTED (0x00000032). The fax
client SHOULD NOT call this method if the protocol version reported by the
server is FAX_API_VERSION_3 (0x00030000). For more information, see <b>FAX_ConnectFaxServer</b> (section
<a href="5cbfd38d-7a14-4560-ad24-9ed78f19a3bb" data-linktype="relative-path">3.1.4.1.10</a>). The fax
client SHOULD call <b>FAX_GetGeneralConfiguration</b> (section <a href="660b4d98-8a20-4391-a232-ca6608e6154f" data-linktype="relative-path">3.1.4.1.40</a>) instead.</p><p>In response, the server MUST validate that the client&#39;s fax
user account has access to query configuration. Then, the server MUST allocate
memory for the archive configuration information to be passed out and the
server MUST fill the archive configuration information with data.</p><p>To indicate success, the server MUST return the buffer that
contains the archive configuration information, along with the buffer size.</p><p>The client SHOULD free the buffer.</p><dl>
<dd>
<div><pre> error_status_t FAX_GetArchiveConfiguration(
   [in] handle_t hFaxHandle,
   [in] FAX_ENUM_MESSAGE_FOLDER Folder,
   [out, size_is(, *BufferSize)] LPBYTE* Buffer,
   [out, ref] LPDWORD BufferSize
 );
</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> 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>Folder: </b>Archive location. This MUST be either
FAX_MESSAGE_FOLDER_INBOX or FAX_MESSAGE_FOLDER_SENTITEMS described in
section <a href="1c7a6f3f-1e5b-40a2-bc48-0729f3a6cf0d" data-linktype="relative-path">2.2.2</a>.</p><p><b>Buffer: </b>A pointer to a <b>FAX_ARCHIVE_CONFIGW</b> (section
<a href="942483fa-960c-4463-8ea2-4fb0c99c1749" data-linktype="relative-path">2.2.27</a>) object. If the
size of the archive exceeds the <b>dwSizeQuotaHighWatermark</b> value and if
the <b>bSizeQuotaWarning</b> member is set to TRUE, an event log warning SHOULD
be issued. If an event log warning was already issued, no more events SHOULD be
issued until the size of the archive drops below the <b>dwSizeQuotaLowWatermark</b>
value. If a fax message stays in the archive longer than the <b>dwAgeLimit</b>
value, it MAY be automatically deleted. If the <b>dwAgeLimit</b> value is zero,
the time limit MUST NOT be used.</p><p><b>BufferSize: </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>)
in which to return the size, in bytes, of the 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 access rights (FAX_ACCESS_QUERY_CONFIG) required for this operation.</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 Buffer parameter is set to a NULL pointer value. &lt;102&gt; § The value specified for the Folder parameter is not FAX_MESSAGE_FOLDER_SENTITEMS or FAX_MESSAGE_FOLDER_INBOX.</td>
 </tr><tr>
  <td>ERROR_NOT_ENOUGH_MEMORY 0x00000008</td>
  <td>Not enough storage is available to process this command. The fax server cannot allocate sufficient memory to hold the FAX_ARCHIVE_CONFIGW to be returned to the client.</td>
 </tr><tr>
  <td>ERROR_NOT_SUPPORTED 0x00000032</td>
  <td>The fax server does not implement this method. Protocol version FAX_API_VERSION_3 (0x00030000) fax servers SHOULD fail this call by returning this error code.</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>