IFaxServer::CreateDocument method (faxcom.h)

The IFaxServer::CreateDocument method creates a FaxDoc object for a specified FaxServer object. The FaxDoc object allows a user to create and transmit a document to one or more fax recipients.

Syntax

HRESULT CreateDocument(
  [in]  BSTR    FileName,
  [out] VARIANT *retval
);

Parameters

[in] FileName

Type: BSTR

Specifies a null-terminated string that contains the fully qualified path and name of the file that contains the fax document to transmit. The path can be a UNC path or a path beginning with a drive letter.

This parameter can contain any valid local or remote file name. The file must be a properly registered file type, and the fax server must be able to access the file.

[out] retval

Type: VARIANT*

Pointer to a VARIANT structure that receives an IDispatch interface pointer to a FaxDoc object. The method returns a pdispVal member with a VT_DISPATCH data type.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

The IFaxServer::CreateDocument method retrieves an IDispatch interface pointer to a FaxDoc object. A fax client application can also access the IFaxDoc interface directly by calling the IUnknown::QueryInterface method to retrieve an interface pointer. The IFaxDoc interface allows a user to set the properties for a fax document, and then transmit the document.

A fax client application should not call the CoCreateInstance function to retrieve an IFaxDoc interface pointer because it will not be instantiated correctly.

Requirements

See also

Fax Service Client API Interfaces

Fax Service Client API for Windows 2000

FaxDoc

FaxServer

IFaxServer

IUnknown::QueryInterface