IFaxDocument2::ConnectedSubmit2 method (faxcomex.h)
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.
Syntax
HRESULT ConnectedSubmit2(
[in] IFaxServer *pFaxServer,
[out] VARIANT *pvFaxOutgoingJobIDs,
[out, retval] long *plErrorBodyFile
);
Parameters
[in] pFaxServer
Type: IFaxServer*
A FaxServer object that specifies a connected fax server.
[out] pvFaxOutgoingJobIDs
Type: VARIANT*
A VARIANT that holds an array of outbound job ID strings, one for each recipient of the fax.
[out, retval] plErrorBodyFile
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
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
Requirement | Value |
---|---|
Minimum supported client | Windows Vista [desktop apps only] |
Minimum supported server | Windows Server 2008 [desktop apps only] |
Target Platform | Windows |
Header | faxcomex.h |
DLL | Fxscomex.dll |