3.1.4.1.68 FAX_RefreshArchive (Opnum 82)

A fax client application calls the FAX_RefreshArchive (Opnum 82) method to notify the server that the archive folder has been changed and SHOULD be refreshed.<145>

In response, the server MUST validate that the client's fax user account has access to the specified folder. On success, the server MUST update its data.

 error_status_t FAX_RefreshArchive(
   [in] handle_t hFaxHandle,
   [in] FAX_ENUM_MESSAGE_FOLDER Folder
 );

hFaxHandle: The RPC binding handle for this call. The client SHOULD reuse the RPC binding handle used as an input hBinding argument for the FAX_ConnectFaxServer (section 3.1.4.1.10) or FAX_ConnectionRefCount (section 3.1.4.1.11) method call used to connect to the fax server.

Folder: A value indicating the archive folder to refresh. The value can be either FAX_MESSAGE_FOLDER_INBOX or FAX_MESSAGE_FOLDER_SENTITEMS. For more information, see FAX_ENUM_MESSAGE_FOLDER (section 2.2.2).<146>

Return Values: 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 2.2.52, or one of the other standard errors defined in [MS-ERREF] section 2.2.

Return value/code	Description
ERROR_ACCESS_DENIED 0x00000005	Access is denied. The required access level SHOULD be FAX_ACCESS_MANAGE_CONFIG.
ERROR_INVALID_PARAMETER 0x00000057	The parameter is incorrect. The folder parameter SHOULD either be FAX_MESSAGE_FOLDER_INBOX or FAX_MESSAGE_FOLDER_SENTITEMS.<147>

Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying RPC protocol [MS-RPCE].