Share via


FaxDocument.Submit method

The Submit method submits a single fax document to the fax service for processing.

Syntax

FaxDocument.Submit( _
  ByVal bstrFaxServerName As String _
) As Variant

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.

Return value

Type: Variant*

Variant that specifies a collection of outbound job IDs, one for each recipient of the fax.

Remarks

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 Submit method requires that the FaxDocument object 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.

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 farSUBMIT_LOW, farSUBMIT_NORMAL, or farSUBMIT_HIGH access right, depending on the Priority of the fax document.

Requirements

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

See also

Visual Basic Example

FaxDocument

IFaxDocument