IFaxServer::Connect method (faxcomex.h)

The IFaxServer::Connect method connects a fax client application to the specified fax server.

Syntax

HRESULT Connect(
  BSTR bstrServerName
);

Parameters

bstrServerName

Type: BSTR

A null-terminated string that specifies the name of the target fax server, such as "computername". If this parameter is NULL or an empty string, the method connects the application to the fax server on the local computer.

Return value

Type: HRESULT

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

Remarks

Before accessing most of the objects of the fax extended Component Object Model (COM), the application must call this method to initiate a connection with an active fax server. A fax server connection is not required for you to access a FaxDocument object. The method fails if the client is not connected to an active fax server.

To connect to the local server, set the bstrServerName parameter to NULL or an empty string. For usage examples, see Connecting to the Fax Server.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header faxcomex.h
DLL Fxscomex.dll

See also

FaxServer

IFaxServer

Visual Basic Example