DeviceManager.getDeviceLink Method

Module: DeviceManager

Definition

Retrieves the connection link for a specified device.

Python

get_device_link(device_id: int) -> str

Parameters

device_id int

in The device’s identifier.

Returns

str

The device’s connection link.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

Dart

static String getDeviceLink(int deviceId)

Parameters

deviceId int

in The device’s identifier.

Returns

String

The device’s connection link.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

C#

public static string GetDeviceLink(int deviceId)

Parameters

deviceId int

in The device’s identifier.

Returns

string

The device’s connection link.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

Java

public static String getDeviceLink(int deviceId) throws DevicesException

Parameters

deviceId int

in The device’s identifier.

Returns

String

The device’s connection link.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

C

int id3DevicesDeviceManager_GetDeviceLink (
    int deviceId,
    char * link,
    int * linkSize)

Parameters

deviceId int

in The device’s identifier.

link char *

out The device’s connection link.

linkSize int *

in Size of the ‘link’ buffer. Receives the minimum required buffer size to hold the ‘link’ string if the given one is too small (including the terminating NULL character), otherwise receives the number of characters in ‘link’ (excluding terminating NULL character).

Returns

int

An error code.

See id3DevicesError file for the list of possible error codes.