C# Class VSNDK.DebugEngine.AD7PortSupplier

Inheritance: IDebugPortSupplier2

Show file Open project: blackberry/VSPlugin Class Usage Examples

Public Methods

Method	Description
AD7PortSupplier ( ) : System	Constructor.
AddPort ( IDebugPortRequest2 pRequest, IDebugPort2 &ppPort ) : int	Adds a port. (http://msdn.microsoft.com/en-ca/library/bb161980.aspx)
CanAddPort ( ) : int	Verifies that a port supplier can add new ports. (http://msdn.microsoft.com/en-ca/library/bb145880.aspx)
Decrypt ( string cipher ) : string	Decrypts a given string. Keep in mind that the decrypted string remains in memory and makes your application vulnerable per se. If runtime protection is essential, SecureString should be used.
EnumPorts ( IEnumDebugPorts2 &ppEnum ) : int	Retrieves a list of all the ports supplied by a port supplier. (http://msdn.microsoft.com/en-ca/library/bb146984.aspx)
GetDescription ( enum_PORT_SUPPLIER_DESCRIPTION_FLAGS pdwFlags, string &pbstrText ) : int	Retrieves the description for the port supplier. (http://msdn.microsoft.com/en-us/library/bb457978.aspx)
GetPort ( System.Guid &guidPort, IDebugPort2 &ppPort ) : int	Gets a port from a port supplier. (http://msdn.microsoft.com/en-ca/library/bb161812.aspx)
GetPortSupplierId ( System.Guid &pguidPortSupplier ) : int	Gets the port supplier identifier. (http://msdn.microsoft.com/en-ca/library/bb146617.aspx)
GetPortSupplierName ( string &pbstrName ) : int	Gets the port supplier name. (http://msdn.microsoft.com/en-ca/library/bb162136.aspx)
RemovePort ( IDebugPort2 pPort ) : int	Removes a port. Not implemented. (http://msdn.microsoft.com/en-ca/library/bb162306.aspx)

Private Methods

Method	Description
CreatePort ( AD7PortRequest port_request ) : AD7Port	Creates an AD7Port.
verifyAndAddPorts ( ) : int

Method Details

AD7PortSupplier() public method

Constructor.

public AD7PortSupplier ( ) : System
return	System

AddPort() public method

Adds a port. (http://msdn.microsoft.com/en-ca/library/bb161980.aspx)

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. (http://msdn.microsoft.com/en-ca/library/bb145880.aspx)

public CanAddPort ( ) : int
return	int

Decrypt() public method

Decrypts a given string.

Keep in mind that the decrypted string remains in memory and makes your application vulnerable per se. If runtime protection is essential, SecureString should be used.

If /// is a null reference.

public Decrypt ( string cipher ) : string
cipher	string	A base64 encoded string that was created /// through the or /// extension methods.
return	string

EnumPorts() public method

Retrieves a list of all the ports supplied by a port supplier. (http://msdn.microsoft.com/en-ca/library/bb146984.aspx)

public EnumPorts ( IEnumDebugPorts2 &ppEnum ) : int
ppEnum	IEnumDebugPorts2	Returns an IEnumDebugPorts2 object containing a list of ports supplied.
return	int

GetDescription() public method

Retrieves the description for the port supplier. (http://msdn.microsoft.com/en-us/library/bb457978.aspx)

public GetDescription ( enum_PORT_SUPPLIER_DESCRIPTION_FLAGS pdwFlags, string &pbstrText ) : int
pdwFlags	enum_PORT_SUPPLIER_DESCRIPTION_FLAGS	Metadata flags for the description.
pbstrText	string	Description of the port supplier.
return	int

GetPort() public method

Gets a port from a port supplier. (http://msdn.microsoft.com/en-ca/library/bb161812.aspx)

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. (http://msdn.microsoft.com/en-ca/library/bb146617.aspx)

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. (http://msdn.microsoft.com/en-ca/library/bb162136.aspx)

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

RemovePort() public method

Removes a port. Not implemented. (http://msdn.microsoft.com/en-ca/library/bb162306.aspx)

public RemovePort ( IDebugPort2 pPort ) : int
pPort	IDebugPort2	An IDebugPort2 object that represents the port to be removed.
return	int