C# Class PowerStudio.DebugEngine.DebugPortSupplier

Inheritance: IDebugPortSupplier2
Exibir arquivo Open project: IntelliTect/PowerStudio

Public Methods

Method Description
AddPort ( IDebugPortRequest2 pRequest, IDebugPort2 &ppPort ) : int

Adds a port.

This method actually creates the requested port as well as adding it to the port supplier's internal list of active ports. The IDebugPortSupplier2::CanAddPort method can be called first to avoid possible time-consuming delays.

CanAddPort ( ) : int

Verifies that a port supplier can add new ports.

Call this method before calling the IDebugPortSupplier2::AddPort method since the latter method creates the port as well as adding it, which could be a time-consuming operation.

EnumPorts ( IEnumDebugPorts2 &ppEnum ) : int

Retrieves a list of all the ports supplied by a port supplier.

GetPort ( System.Guid &guidPort, IDebugPort2 &ppPort ) : int

Gets a port from a port supplier.

GetPortSupplierId ( System.Guid &pguidPortSupplier ) : int

Gets the port supplier identifier.

GetPortSupplierName ( string &pbstrName ) : int

Gets the port supplier name.

RemovePort ( IDebugPort2 pPort ) : int

Removes a port.

This method removes the port from the port supplier's internal list of active ports.

Method Details

AddPort() public method

Adds a port.
This method actually creates the requested port as well as adding it to the port supplier's internal list of active ports. The IDebugPortSupplier2::CanAddPort method can be called first to avoid possible time-consuming delays.
public AddPort ( IDebugPortRequest2 pRequest, IDebugPort2 &ppPort ) : int
pRequest IDebugPortRequest2 An IDebugPortRequest2 object that describes the port to be added.
ppPort IDebugPort2 Returns an IDebugPort2 object that represents the port.
return int

CanAddPort() public method

Verifies that a port supplier can add new ports.
Call this method before calling the IDebugPortSupplier2::AddPort method since the latter method creates the port as well as adding it, which could be a time-consuming operation.
public CanAddPort ( ) : int
return int

EnumPorts() public method

Retrieves a list of all the ports supplied by a port supplier.
public EnumPorts ( IEnumDebugPorts2 &ppEnum ) : int
ppEnum IEnumDebugPorts2 Returns an IEnumDebugPorts2 object containing a list of ports supplied.
return int

GetPort() public method

Gets a port from a port supplier.
public GetPort ( System.Guid &guidPort, IDebugPort2 &ppPort ) : int
guidPort System.Guid Globally unique identifier (GUID) of the port.
ppPort IDebugPort2 Returns an IDebugPort2 object that represents the port.
return int

GetPortSupplierId() public method

Gets the port supplier identifier.
public GetPortSupplierId ( System.Guid &pguidPortSupplier ) : int
pguidPortSupplier System.Guid Returns the GUID of the port supplier.
return int

GetPortSupplierName() public method

Gets the port supplier name.
public GetPortSupplierName ( string &pbstrName ) : int
pbstrName string Returns the name of the port supplier.
return int

RemovePort() public method

Removes a port.
This method removes the port from the port supplier's internal list of active ports.
public RemovePort ( IDebugPort2 pPort ) : int
pPort IDebugPort2 An IDebugPort2 object that represents the port to be removed.
return int