IVMSerialPort::Configure method

The Configure method configures the serial port.

Syntax

HRESULT Configure(
  [in] VMSerialPortType portType,
  [in] BSTR             portName,
  [in] VARIANT_BOOL     connectImmediately
);

Parameters

portType [in]

Type of serial port.

portName [in]

Name of the serial port (for example, COM1 for vmSerialPortHostPort, C:\SerialPort.txt for vmSerialPortTextFile, or \\servername\pipe\pipename for vmSerialPortNamedPipe).

connectImmediately [in]

TRUE if the host serial port should be opened immediately when the virtual machine is started. Ignored if type is not vmSerialPortHostPort.

Return value

This method can return one of these values.

This method supports standard return values, as well as the following. For information on Virtual Server specific return values not listed below, see HRESULT Codes Specific to the Virtual Server.

Return code	Description
S_OK	The operation was successful.
E_POINTER	The portName parameter is NULL
E_INVALIDARG	The portType parameter is not valid.
VM_E_VM_UNKNOWN	The configuration is unknown.
VM_E_PREF_ILLEGAL_VALUE	The specified port is already in use.
DISP_E_EXCEPTION	An unexpected error occurred.

Requirements

Product	Microsoft Virtual Server 2005 onWindows Server 2003
Download	Microsoft Virtual Server 2005 R2 SP1 Update onWindows Server 2008orWindows Server 2003
Header	VsComInterfaces.h

See also

IVMSerialPort

VMSerialPortType