IPortCreationParams Interface

This interface is implemented by optional port creation parameters object and may be used to customize the creation of a new virtual serial port. You may pass a reference to this interface to the following methods:

Scripting environment may pass any object that (partially) corresponds to this interface as all its properties are optional. There is also ISerialPortLibrary.createPortCreationParams helper method that can be used in managed or native environments to create a default implementation of this interface.

Declaration

interface IPortCreationParams {
    // Properties
    ${portName}?: string | number;
    ${deviceName}?: string;
    ${compatibilityFlags}?: ${CompatibilityFlags};
}

public interface IPortCreationParams
{
    // Properties
    object ${portName} { get; set; }
    string ${deviceName} { get; set; }
    ${CompatibilityFlags} ${compatibilityFlags} { get; set; }
}

struct IPortCreationParams : IDispatch
{
    // Properties
    _variant_t ${portName};  // get set 
    _bstr_t ${deviceName};  // get set 
    ${CompatibilityFlags} ${compatibilityFlags};  // get set 
};

IPortCreationParams Properties

portName

portName?: string | number;

object portName { get; set; }

_variant_t portName;  // get set

Overrides the auto-assigned port name. May be an integer specifying the port number or a string COMn where n is the port number.

If omitted, the next available port number will be used.

deviceName

deviceName?: string;

string deviceName { get; set; }

_bstr_t deviceName;  // get set

Overrides default virtual device name (as seen in the Windows Device Manager).

compatibilityFlags

compatibilityFlags?: ${CompatibilityFlags};

${CompatibilityFlags} compatibilityFlags { get; set; }

${CompatibilityFlags} compatibilityFlags;  // get set

Overrides default device compatibility flags. See the CompatibilityFlags enumeration for more information.

If not set, global compatibility flags set via the ISerialPortLibrary.compatibilityFlags property are used.

CompatibilityFlags