DeviceChannel.checkCommand Method

Module: DeviceChannel

Definition

(C++/dotnet): Checks if a specific command is available on the device.

C#

public bool CheckCommand(string cmd)

Parameters

cmd string

in The command to check.

Returns

bool

Outputs true if the command exists, false otherwise.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

C

int id3DevicesDeviceChannel_CheckCommand (
    ID3_DEVICES_DEVICE_CHANNEL hDeviceChannel,
    const char * cmd,
    bool * result)

Parameters

hDeviceChannel ID3_DEVICES_DEVICE_CHANNEL

in Handle to the DeviceChannel object.

cmd const char *

in The command to check.

result bool *

out Outputs true if the command exists, false otherwise.

Returns

int

An error code.

See id3DevicesError file for the list of possible error codes.