IDevice Interface

This interface is implemented by a USB device object. It also inherits IRemoteDevice interface.

Declaration

interface IDevice extends ${IRemoteDevice} {
    // Properties
    readonly ${remoteAddress}: string;
    readonly ${authKey}: string;
    readonly ${configured}: boolean;
    readonly ${connected}: boolean;

    // Methods
    ${remove}(): void;
}

public interface IDevice : ${IRemoteDevice}
{
    // Properties
    string ${remoteAddress} { get; }
    string ${authKey} { get; }
    bool ${configured} { get; }
    bool ${connected} { get; }

    // Methods
    void ${remove}();
}

struct IDevice : IRemoteDevice
{
    // Properties
    _bstr_t ${remoteAddress};  // get 
    _bstr_t ${authKey};  // get 
    VARIANT_BOOL ${configured};  // get 
    VARIANT_BOOL ${connected};  // get 

    // Methods
    HRESULT ${remove}();
};

IDevice Properties

remoteAddress

readonly remoteAddress: string;

string remoteAddress { get; }

_bstr_t remoteAddress;  // get

Remote server address.

authKey

readonly authKey: string;

string authKey { get; }

_bstr_t authKey;  // get

Device authentication key.

configured

readonly configured: boolean;

bool configured { get; }

VARIANT_BOOL configured;  // get

Holds true if the device is configured. This property returns false if the device has been deleted.

connected

readonly connected: boolean;

bool connected { get; }

VARIANT_BOOL connected;  // get

Holds true if connection to the remote device has been successfully established and false otherwise.

IDevice Methods

remove

remove(): void;

void remove();

HRESULT remove();

Disconnect and remove this shared device. The property configured becomes false after you call this method. Corresponding device control process is shut down and device is removed from the client computer.