FaxDocument.ConnectedSubmit2 method

Submits one or more fax documents to the connected FaxServer. This method returns an array of fax job ID strings, one for each recipient of the fax.

Note

This method is supported only in Windows Vista and later.

 

Syntax

FaxDocument.ConnectedSubmit2( _
  ByVal pFaxServer As IFaxServer, _
  ByRef pvFaxOutgoingJobIDs As Variant _
) As Long

Parameters

pFaxServer [in]

Type: IFaxServer*

A FaxServer object that specifies a connected fax server.

pvFaxOutgoingJobIDs [out]

Type: Variant*

A Variant that holds an array of outbound job ID strings, one for each recipient of the fax.

Return value

Type: Long*

A Long representing the zero-based position of the submitted file that caused the fax send operation to fail. See Remarks.

Remarks

Note

To succeed, the ConnectedSubmit2 method requires that the fax have at least one recipient, and either a cover page or a fax body. You can only use this method if the server (remote or local) is installed as a network printer on the local computer.

 

You must set the Bodies property with a semi-colon delimited list of the files to be faxed before calling ConnectedSubmit2.

Note

The Body property must be NULL to use ConnectedSubmit2.

 

This method is not supported for a remote connection to a fax server running Windows XP Home Edition or Windows XP Professional, and will return the error: FAX_E_NOT_SUPPORTED_ON_THIS_SKU.

To use this method, a user must have the far2SUBMIT_LOW, far2SUBMIT_NORMAL, or far2SUBMIT_HIGH access set correctly, depending on the Priority of the fax document.

To illustrate plErrorBodyFile, here is an example: The following list of files is submitted as the value of Bodies:

"MyTextFile.txt;AnotherTextFile.txt;MyPDFfile.pdf;MyWordFile.doc".

Because the "*.pdf" extension is not supported, the send operation will fail and plErrorBodyFile will return as 2.

Requirements

Minimum supported client
Windows Vista [desktop apps only]
Minimum supported server
Windows Server 2008 [desktop apps only]
Header
FaxComex.h
DLL
Fxscomex.dll

See also

FaxDocument

IFaxDocument2