DebugConnect

The DebugConnect and DebugConnectWide functions create a new client object and return an interface pointer to it. The client object will be connected to a remote host.

HRESULT
  DebugConnect(
    IN PCSTR  RemoteOptions,
    IN REFIID  InterfaceId,
    OUT PVOID *  Interface
    );

HRESULT
  DebugConnectWide(
    IN PCWSTR  RemoteOptions,
    IN REFIID  InterfaceId,
    OUT PVOID *  Interface
    );

#ifdef UNICODE
#define DebugConnectT DebugConnectWide
#else
#define DebugConnectT DebugConnect
#endif

Parameters

RemoteOptions

Specifies how the debugger engine will connect to the remote host. These are the same options that get passed to the -remote option on the command line. For details on the syntax of this string, see Activating a Debugging Client.

InterfaceId

Specifies the interface identifier (IID) of the desired debugger engine client interface. This is the type of the interface that will be returned in Interface. For information about the interface identifier, see COM Interfaces.

Interface

Receives an interface pointer for the new client. The type of this interface is specified by InterfaceId.

Return Value

S_OK

The method was successful.

This method may also return error values. See Return Values for more details.

Comments

As with IUnknown::QueryInterface, when the returned interface is no longer needed, its IUnknown::Release method should be called.

Requirements

Headers: Defined in dbgeng.h. Include dbgeng.h.

See Also

Client Objects, Process Server and Smart Client