DocumentBase.SendFaxOverInternet Method
Sends the document to a fax service provider, who faxes the document to one or more specified recipients.
Namespace: Microsoft.Office.Tools.Word
Assembly: Microsoft.Office.Tools.Word.v4.0.Utilities (in Microsoft.Office.Tools.Word.v4.0.Utilities.dll)
Syntax
'Declaration
Public Sub SendFaxOverInternet ( _
ByRef recipients As Object, _
ByRef subject As Object, _
ByRef showMessage As Object _
)
public void SendFaxOverInternet(
ref Object recipients,
ref Object subject,
ref Object showMessage
)
Parameters
- recipients
Type: System.Object%
The fax numbers and e-mail addresses of the people to whom to send the fax. Separate multiple recipients with a semicolon.
- subject
Type: System.Object%
The subject line for the faxed document.
- showMessage
Type: System.Object%
true to display the fax message before sending it. false to send the fax without displaying the fax message.
Remarks
Using this method requires that a fax service is enabled on a user's computer. If a fax service is not enabled, the SendFaxOverInternet method throws an exception.
The format used for specifying fax numbers in the Recipients parameter is either recipientsfaxnumber@usersfaxprovider or recipientsname@recipientsfaxnumber. You can access the user's fax provider information using the following registry path:
HKEY_CURRENT_USER\Software\Microsoft\Office\11.0\Common\Services\Fax
Use the FaxAddress key value at this registry location to determine the format to use for a user. If this registry entry does not exist, no fax service is available.
Optional Parameters
For information on optional parameters, see Optional Parameters in Office Solutions.
Examples
The following code example uses the SendFaxOverInternet method to fax the document to a fax number using the format recipientsfaxnumber@usersfaxprovider. The code displays the document before sending the fax. To use this example, run it from the ThisDocument class in a document-level project.
Private Sub DocumentSendFaxOverInternet()
Me.SendFaxOverInternet("14255550101@consolidatedmessenger.com", _
"For your review.", True)
End Sub
private void DocumentSendFaxOverInternet()
{
object recipients = "14255550101@consolidatedmessenger.com";
object subject = "For your review.";
object showMessage = true;
this.SendFaxOverInternet(ref recipients, ref subject,
ref showMessage);
}
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.