FaxDocument.Submit2 method
Submits one or more documents to the fax service for processing.
Note
This method is supported only in Windows Vista and later.
Syntax
FaxDocument.Submit2( _
ByVal bstrFaxServerName As String, _
ByRef pvFaxOutgoingJobIDs As Variant _
) As Long
Parameters
-
bstrFaxServerName [in]
-
Type: String
String that specifies a fax server. If this parameter is NULL or an empty string, the local fax server is specified.
-
pvFaxOutgoingJobIDs [out]
-
Type: Variant*
Variant that specifies a collection of outbound job IDs, 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
You must set the Bodies property with a semi-colon delimited list of the files to be faxed before calling Submit2.
Note
This Body property must be NULL to use Submit2.
You must provide the server name when submitting the document. To submit the document to the local server, set the bstrFaxServerName parameter to Null or an empty string. The method returns a collection of fax job IDs, one for each recipient of the fax.
To succeed, the Submit2 method requires that the fax has 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.
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.
As an example of plErrorBodyFile, consider the following 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 |
|
| DLL |
|
See also