IFaxDocument2::ConnectedSubmit2 method

Applies to: desktop apps only

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

HRESULT ConnectedSubmit2(
  [in]           IFaxServer *pFaxServer,
  [out]          VARIANT *pvFaxOutgoingJobIDs,
  [out, retval]  LONG *plErrorBodyFile
);

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.

plErrorBodyFile [out, retval]

Type: LONG*

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

Return value

Type: HRESULT

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

Remarks

Note  To succeed, the IFaxDocument2::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 IFaxDocument2::Bodies property with a semi-colon delimited list of the files to be faxed before calling IFaxDocument2::ConnectedSubmit2.

Note  The Body property must be NULL to use IFaxDocument2::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 IFaxDocument2::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

Minimum supported server

Windows Server 2008

Header

FaxComex.h

DLL

Fxscomex.dll

See also

FaxDocument
IFaxDocument2

 

 

Build date: 5/5/2012

Community Additions

ADD
Show: