IFaxServer::get_ArchiveDirectory

The IFaxServer::get_ArchiveDirectory method retrieves the ArchiveDirectory property for a FaxServer object. The ArchiveDirectory property is a null-terminated string that contains the location in which the fax server stores archived outbound faxes.

Visual Basic Reference

HRESULT get_ArchiveDirectory(
  BSTR *pVal  // receives archive directory string
);

Parameters

pVal

[out] Pointer to a string that contains the fully qualified path of the directory in which the fax server should archive outgoing fax transmissions. The path can be a UNC path or a path beginning with a drive letter. The fax server ignores this value if the ArchiveOutboundFaxes property is FALSE.

Return Values

Returns an HRESULT value indicating success or failure. If the method succeeds, it returns S_OK. Otherwise, it returns a COM-defined error code.

You should not check directly for success or failure. Use the COM SUCCEEDED and FAILED macros instead.

Remarks

Set the ArchiveOutboundFaxes property to TRUE to archive faxes in the directory specified by the ArchiveDirectory property. The fax server must have access to the directory to successfully store outbound fax transmissions.

The IFaxServer::get_ArchiveDirectory method allocates the memory required for the buffer pointed to by the pVal parameter. The client application must call the SysFreeString function to deallocate the resources associated with this parameter. For more information, see Freeing Fax Resources.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Unsupported.
  Header: Declared in faxcom.h.
  Import Library: Included as a resource in faxcom.dll.

See Also

Fax Service Client Application Programming Interface Overview, Fax Service Client API Interfaces, IFaxServer, IFaxServer::put_ArchiveDirectory, IFaxServer::get_ArchiveOutboundFaxes, IFaxServer::put_ArchiveOutboundFaxes, SysFreeString