Библиотека RshUniDriver  SDK 2.1
Документация по программированию
 Указатель Структуры данных Файлы Функции Переменные Перечисления Элементы перечислений Макросы Страницы
Работа с RshUniDriver в среде LabVIEW

Оглавление

Типы данных

Различные структуры данных, используемые для управления устройствами и передачи параметров.

RshChannel.ctl

Параметры аналогового канала. Данный кластер используется для задания параметров измерительных каналов в структурах инициализации.

RshUniDriver_lvlib_RshChannelctlc.png

RshInitDAC.ctl

Структура инициализации для управления ЦАПами. LabVIEW аналог (кластер) структуры инициализации URshInitDAC.

RshUniDriver_lvlib_RshInitDACctlc.png

RshInitDMA.ctl

Структура инициализации DMA. LabVIEW аналог (кластер) структуры инициализации URshInitDMA.

RshUniDriver_lvlib_RshInitDMActlc.png

RshInitMemory.ctl

Структура инициализации Memory. LabVIEW аналог (кластер) структуры инициализации URshInitMemory.

RshUniDriver_lvlib_RshInitMemoryctlc.png

RshInitPort.ctl

Структура инициализации для управления цифровым портом устройства. LabVIEW аналог (кластер) структуры инициализации URshInitPort.

RshUniDriver_lvlib_RshInitPortctlc.png

RshSynchroChannel.ctl

Параметры входа внешней синхроназиции. Данный кластер используется для задания параметров входа внешней синхронизации в структуре инициализации Memory.

RshUniDriver_lvlib_RshSynchroChannelctlc.png

Перечисления

Списки констант, использующихся при вызове различных функций.

RshCapsCodes.ctl

Список капс-кодов (возможности устройства и базовой библиотеки, см RSH_CAPS)

RshUniDriver_lvlib_RshCapsCodesctlc.png

RshDMAMode.ctl

Режимы работы для ДМА устройств (непрерывный сбор данных или режим "Старт-Стоп")

RshUniDriver_lvlib_RshDMAModectlc.png

RshGetCodes.ctl

Список Get-кодов. Используются для получения различной информации об устройстве и библиотеке абстракции. См. RSH_GET.

Коды из данного списка передаются в качестве параметров в функции Get:

RshUniDriver_lvlib_RshGetCodesctlc.png

RshStartTypes.ctl

Список вариантов запуска сбора данных (или генерации сигнала). Аналог перечисления URshStart.

RshUniDriver_lvlib_RshStartTypesctlc.png

Управление устройством

Основные модули, использующиеся для управления устройством. Смотрите также описание функций для получения информации, инициализации и получения буфера данных.

GetDeviceHandle.vi

RshUniDriver_lvlib_GetDeviceHandlec.png

Получение идентификатора драйвера

Параметры VI:

Параметр Тип

Описание

deviceName
cstr.png

Строка с названием устройства (имя ветки в реестре).

error in (no error)
cerrcodeclst.png

Контроль ошибок (вход)

function return
iu32.png

Возвращаемое значение - RSH_API_SUCCESS или код ошибки.

deviceHandle out
iu32.png

Полученный идентификатор драйвера устройства (используется для обращения к устройству при вызове всех остальных VI).

error out
ierrcodeclst.png
Контроль ошибок (выход)

Описание функции:

Аргументы
[in]deviceNameСтрока с названием устройства (имя ветки в реестре).
[in,out]deviceHandleУказатель на переменную, в которую будет помещен идентификатор драйвера.
Возвращает
RSH_API_SUCCESS или код ошибки.

Данная фукнция используется для получения идентификатора драйвера, который в дальнейшем используется для управления устройством. Все остальные функции библиотеки RshUniDriver (такие как UniDriverConnect(), UniDriverStart(), UniDriverGetData() и т.д.) требуют идентификатор драйвера в качестве параметра.
При вызове данной функции внутри библиотеки RshUniDriver.dll происходит загрузка объекта с интерфейсом устройства IRshDevice из соответствующей библиотеки абстракции (например, LA20USB.dll). Полученный объект хранится в памяти до выгрузки библиотеки RshUniDriver или до вызова функции UniDriverCloseDeviceHandle(), а его идентификатор возвращается в переменной deviceHandle.

Сигнатура функции из RshUniDriver.dll:

unsigned __stdcall UniDriverGetDeviceHandle(char* deviceName,unsigned int* deviceHandle);

CloseDeviceHandle.vi

RshUniDriver_lvlib_CloseDeviceHandlec.png

Освобождение драйвера устройства

Параметры VI:

Параметр Тип

Описание

error in (no error)
cerrcodeclst.png
Контроль ошибок (вход)
deviceHandle
cu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi

function return
iu32.png

Возвращаемое значение - RSH_API_SUCCESS или код ошибки.

deviceHandle out
iu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi (выход).

Значение данного параметра не меняется в процессе выполнения, и нужно только для контроля за потоком выполнения программы в LabVIEW (последовательность вызова VI).

error out
ierrcodeclst.png
Контроль ошибок (выход)

Описание функции:

Аргументы
[in,out]deviceHandleИдентификатор драйвера устройства, полученный в результате вызова функции UniDriverGetDeviceHandle()
Возвращает
RSH_API_SUCCESS или код ошибки.

Данная функция используется для освобождения ресурсов, связанных с загруженной библиотекой абстракции устройства. Как правило, данную функцию нужно вызывать при выходе из программы, либо когда загруженный драйвер устройства больше не нужен.
Обратите внимание, что после успешного вызова данной функции значение идентификатора deviceHandle уже не действительно, т.к. объект, на который он ссылается, будет удален.

Сигнатура функции из RshUniDriver.dll:

unsigned __stdcall UniDriverCloseDeviceHandle(unsigned int deviceHandle);

Connect.vi

Подключение к устройству.

RshUniDriver_lvlib_Connectc.png

Подключение к устройству

Параметры VI:

Параметр Тип

Описание

deviceHandle
cu32.png

Идентификатор драйвера устройства, полученный в результате вызова функции GetDeviceHandle.vi

deviceIndex
cu32.png

В зависимости от выбранного режима (параметр mode), данный параметр задает либо порядковый номер устройства в системе, либо заводской номер устройства, к которому нужно подключиться.

mode
cu32.png

Способ индексирования. Если выбран режим RSH_CONNECT_MODE_BASE, в качестве параметра deviceIndex нужно передать базовый адрес устройства. Нумерация начинается с 1.

Если выбран режим RSH_CONNECT_MODE_SERIAL_NUMBER, в качестве параметра deviceIndex нужно передать заводской номер устройства.

error in (no error)
cerrcodeclst.png

Контроль ошибок (вход)

function return
iu32.png

Возвращаемое значение.

В случае успеха будет равно RSH_API_SUCCESS.

error out
ierrcodeclst.png

Контроль ошибок (выход)

deviceHandle out
iu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi (выход).

Значение данного параметра не меняется в процессе выполнения, и нужно только для контроля за потоком выполнения программы в LabVIEW (последовательность вызова VI).

Описание функции:

Аргументы
[in]deviceHandleИдентификатор драйвера устройства, полученный в результате вызова функции UniDriverGetDeviceHandle()
[in]deviceIndexИдентификатор устройства (базовый адрес либо заводской номер).
[in]modeРежим подключения
Допустимые варианты: RSH_CONNECT_MODE_BASE или RSH_CONNECT_MODE_SERIAL_NUMBER.
Возвращает
RSH_API_SUCCESS или код ошибки.

С помощью данной функции можно подключиться к выбранному устройству.
В зависимости от параметра mode, идентификатор устройства может быть либо базовым адресом (индексация устройств в системе начинается с 1), либо заводским номером устройства (данный вариант возможен не для всех устройств).
После успешного вызова данной функции будет осуществлено физическое подключение к заданному устройству. По сути, до вызова данной функции все операции выполняются только с программными объектами (библиотекам).

Сигнатура функции из RshUniDriver.dll:

unsigned __stdcall UniDriverConnect(unsigned int deviceHandle, unsigned int deviceIndex, unsigned int mode);

Start.vi

RshUniDriver_lvlib_Startc.png

Запуск сбора данных (генерации сигнала)

Параметры VI:

Параметр Тип

Описание

deviceHandle
cu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi

error in (no error)
cerrcodeclst.png

Контроль ошибок (вход)

function return
iu32.png

Возвращаемое значение - RSH_API_SUCCESS или код ошибки.

error out
ierrcodeclst.png

Контроль ошибок (выход)

deviceHandle out
iu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi (выход).

Значение данного параметра не меняется в процессе выполнения, и нужно только для контроля за потоком выполнения программы в LabVIEW (последовательность вызова VI).

Описание функции:

Аргументы
[in]deviceHandleИдентификатор драйвера устройства, полученный в результате вызова функции UniDriverGetDeviceHandle()
Возвращает
RSH_API_SUCCESS или код ошибки.

Вызов данной функции запускает сбор данных, либо генерацию сигнала в случае генераторов.

Сигнатура функции из RshUniDriver.dll:

unsigned __stdcall UniDriverStart(unsigned int deviceHandle);

Stop.vi

RshUniDriver_lvlib_Stopc.png

Остановка сбора данных (генерации сигнала)

Параметры VI:

Параметр Тип

Описание

deviceHandle
cu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi

error in (no error)
cerrcodeclst.png

Контроль ошибок (вход)

function return
iu32.png

Возвращаемое значение - RSH_API_SUCCESS или код ошибки.

error out
ierrcodeclst.png

Контроль ошибок (выход)

deviceHandle out
iu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi (выход).

Значение данного параметра не меняется в процессе выполнения, и нужно только для контроля за потоком выполнения программы в LabVIEW (последовательность вызова VI).

Описание функции:

Аргументы
[in]deviceHandleИдентификатор драйвера устройства, полученный в результате вызова функции UniDriverGetDeviceHandle()
Возвращает
RSH_API_SUCCESS или код ошибки.

Вызов данной функции останавливает сбор данных, либо генерацию сигнала в случае генераторов.

Сигнатура функции из RshUniDriver.dll:

unsigned __stdcall UniDriverStop(unsigned int deviceHandle);

IsCapable.vi

RshUniDriver_lvlib_IsCapablec.png

Проверка возможностей устройства и библиотеки

Параметры VI:

Параметр Тип

Описание

deviceHandle
cu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi

error in (no error)
cerrcodeclst.png

Контроль ошибок (вход)

capsCode
cu32.png

CAPS-код. Одна из констант перечисления RSH_CAPS.

error out
ierrcodeclst.png

Контроль ошибок (выход)

deviceHandle out
iu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi (выход).

Значение данного параметра не меняется в процессе выполнения, и нужно только для контроля за потоком выполнения программы в LabVIEW (последовательность вызова VI).

Capable
ibool.png
Результат проверки: если TRUE, код поддерживается, если FALSE - нет.

Описание функции:

Аргументы
[in]deviceHandleИдентификатор драйвера устройства, полученный в результате вызова функции UniDriverGetDeviceHandle()
[in]capsCodeОдна из констант перечисления RSH_CAPS
Возвращает
RSH_API_SUCCESS или код ошибки.

С помощью данной функции можно проверить поддержку устройством различных аппаратных и программных возможностей, режимов работы и прочего. Подробности - в описании RSH_CAPS.
Если функция возвращает код RSH_API_SUCCESS - значит запрашиваемая возможность поддерживается устройством.

Сигнатура функции из RshUniDriver.dll:

unsigned __stdcall UniDriverIsCapable(unsigned int deviceHandle, unsigned int capsCode);

Вспомогательные функции

GetErrorString.vi

RshUniDriver_lvlib_GetErrorStringc.png

Получение строки с описанием ошибки

Параметры VI:

Параметр Тип

Описание

error
cu32.png

Код ошибки, полученный в результате вызова одной из функций RSH_API.

language
ci32.png

Язык - одна из констант перечисления RSH_LANGUAGE

error in (no error)
cerrcodeclst.png

Контроль ошибок (вход)

function return
iu32.png

Возвращаемое значение - RSH_API_SUCCESS или код ошибки.

description out
istr.png

Результат выполнения функции: строка с описанием ошибки

error out
ierrcodeclst.png
Контроль ошибок (выход)

Описание функции:

Аргументы
[in]errorКод ошибки, полученный в результате вызова одной из функций RshUniDriver
[in,out]descriptionУказатель на массив (строку) типа char*, в который будут скопированы данные (строка с описанием ошибки).
[in]maxLengthМаксимальный размер строки (должен быть равен размеру выделенной памяти в буфере description).
[in]languageЯзык описания (одна из констант - RSH_LANGUAGE_ENGLISH или RSH_LANGUAGE_RUSSIAN)
Возвращает
RSH_API_SUCCESS или код ошибки.

Данная функция позволяет получить строку с описанием ошибки по ее коду.
Эта функция - аналог функции UniDriverGetError(), но для передачи строки не используется специальная структура.
Пример использования:

char errorDesc[1024];
printf("Function failed with error:\n[0x%08X] - %s", code, errorDesc);
Предупреждения
Память под данные должна быть выделена заранее, в программе пользователя. Внутри библиотеки UniDriver происходит только копирование в переданный буфер.

Сигнатура функции из RshUniDriver.dll:

unsigned __stdcall UniDriverLVGetError(unsigned int error, char* description , int language);

ErrorConverter.vi

RshUniDriver_lvlib_ErrorConverterc.png

Данный модуль используется для получения описания ошибки (а точнее, заполнения стандартного кластера контроля ошибок). Переданный код ошибки (полученный в результате выполнения одной из функций) используется для формирования строки с описанием ошибки RSH SDK.

Параметр Тип

Описание

error code
cu32.png

Код ошибки, полученный в результате выполнения одной из функций RSH SDK.

error in (no error)
cerrcodeclst.png

Контроль ошибок (вход)

error out
ierrcodeclst.png
Контроль ошибок (выход)

RshDevice::Init() - инициализация устройства

Для передачи параметров инициализации в LabVIEW используется несколько функций, каждая из которых работает с определенной структурой инициализации.

InitDAC.vi

RshUniDriver_lvlib_InitDACc.png

Инициализация устройства с использованием структуры RshInitDAC (кластер RshInitDAC.clb)

Параметры VI:

Параметр Тип

Описание

deviceHandle
cu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi

initializationMode
cu32.png

Режим инициализации - одна из констант перечисления RSH_INIT_MODES

error in (no error)
cerrcodeclst.png

Контроль ошибок (вход)

Initialization structure
cnclst.png

Структура инициализации - заполненный кластер RshInitDAC.clb

function return
iu32.png

Возвращаемое значение - RSH_API_SUCCESS или код ошибки.

error out
ierrcodeclst.png

Контроль ошибок (выход)

deviceHandle out
iu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi (выход).

Значение данного параметра не меняется в процессе выполнения, и нужно только для контроля за потоком выполнения программы в LabVIEW (последовательность вызова VI).

Initialization structure out
inclst.png
Структура инициализации (выход). Значения параметров могут быть откорректированы в процессе инициализации!

Данная функция используется для управления ЦАПами.


InitDMA.vi

RshUniDriver_lvlib_InitDMAc.png

Инициализация устройства с использованием структуры RshInitDMA (кластер RshInitDMA.clb)

Параметры VI:

Параметр Тип

Описание

deviceHandle
cu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi

initializationMode
cu32.png

Режим инициализации - одна из констант перечисления RSH_INIT_MODES

error in (no error)
cerrcodeclst.png

Контроль ошибок (вход)

Initialization structure
ccclst.png

Структура инициализации - заполненный кластер RshInitDMA.clb

function return
iu32.png

Возвращаемое значение - RSH_API_SUCCESS или код ошибки.

error out
ierrcodeclst.png

Контроль ошибок (выход)

deviceHandle out
iu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi (выход).

Значение данного параметра не меняется в процессе выполнения, и нужно только для контроля за потоком выполнения программы в LabVIEW (последовательность вызова VI).

Initialization structure out
icclst.png
Структура инициализации (выход). Значения параметров могут быть откорректированы в процессе инициализации!

Данная функция используется для инициализации устройства с использованием структуры инициализации RshInitDMA.clb


InitMemory.vi

RshUniDriver_lvlib_InitMemoryc.png

Инициализация устройства с использованием структуры RshInitMemory (кластер RshInitMemory.clb)

Параметры VI:

Параметр Тип

Описание

deviceHandle
cu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi

initializationMode
cu32.png

Режим инициализации - одна из констант перечисления RSH_INIT_MODES

error in (no error)
cerrcodeclst.png

Контроль ошибок (вход)

Initialization structure
ccclst.png

Структура инициализации - заполненный кластер RshInitMemory.clb

function return
iu32.png

Возвращаемое значение - RSH_API_SUCCESS или код ошибки.

error out
ierrcodeclst.png

Контроль ошибок (выход)

deviceHandle out
iu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi (выход).

Значение данного параметра не меняется в процессе выполнения, и нужно только для контроля за потоком выполнения программы в LabVIEW (последовательность вызова VI).

Initialization structure out
icclst.png
Структура инициализации (выход). Значения параметров могут быть откорректированы в процессе инициализации!

Данная функция используется для инициализации устройства с использованием структуры инициализации RshInitMemory.clb


InitPort.vi

RshUniDriver_lvlib_InitPortc.png

Инициализация устройства с использованием структуры RshInitPort (кластер RshInitPort.clb)

Параметры VI:

Параметр Тип

Описание

deviceHandle
cu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi

initializationMode
cu32.png

Режим инициализации - одна из констант перечисления RSH_INIT_MODES

error in (no error)
cerrcodeclst.png

Контроль ошибок (вход)

Initialization structure
cnclst.png

Структура инициализации - заполненный кластер RshInitPort.clb

function return
iu32.png

Возвращаемое значение - RSH_API_SUCCESS или код ошибки.

error out
ierrcodeclst.png

Контроль ошибок (выход)

deviceHandle out
iu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi (выход).

Значение данного параметра не меняется в процессе выполнения, и нужно только для контроля за потоком выполнения программы в LabVIEW (последовательность вызова VI).

Initialization structure out
inclst.png
Структура инициализации (выход). Значения параметров могут быть откорректированы в процессе инициализации!

Данная функция используется для управления цифровыми портами устройства (структура инициализации RshInitPort.clb)


IRshDevice::Get() - получение массивов

Для получения информации в виде массивов (например, список коэффициентов усиления, частот и т.п.) в библиотеке RshUniDriver используются функции, которые, по сути, являются оберткой метода IRshDevice::Get(). Данные функции используются для получения массивов определенного типа.

GetArrayChar.vi

RshUniDriver_lvlib_GetArrayCharc.png

Получение информации об устройстве или библиотеке (char* - массив).

Параметры VI:

Параметр Тип

Описание

deviceHandle
cu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi

size
cu32.png

Размер массива - максимальное количество элементов, которые можно скопировать в массив.

error in (no error)
cerrcodeclst.png

Контроль ошибок (вход)

mode
cu32.png

Одна из констант перечисления RSH_GET. Для данного VI подходят константы, в описании которых указан тип данных RSH_BUFFER_S8

data in
c1di8.png

Массив, в который будут помещены данные

function return
iu32.png

Возвращаемое значение - RSH_API_SUCCESS или код ошибки.

error out
ierrcodeclst.png

Контроль ошибок (выход)

data out
i1di8.png

Заполненный данными (выходной) массив

deviceHandle out
iu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi (выход).

Значение данного параметра не меняется в процессе выполнения, и нужно только для контроля за потоком выполнения программы в LabVIEW (последовательность вызова VI).

Описание функции:

Аргументы
[in]deviceHandleИдентификатор драйвера устройства, полученный в результате вызова функции UniDriverGetDeviceHandle()
[in]modeОдна из констант перечисления RSH_GET
[in]sizeРазмер массива - максимальное количество элементов, которые можно скопировать в массив, указатель на который передается в параметре data.
[in,out]receivedПосле успешного выполнения функции в даннной переменной будет возвращено количество фактически скопированных элементов.
[in,out]dataУказатель на массив, в который будут скопированы данные
Возвращает
RSH_API_SUCCESS или код ошибки.

Данная функция - аналог функции UniDriverGet(). Отличие в том, что для передачи данных не используется специальная структура данных - можно просто передать указатель на массив нужного типа.
Тип данных, указанный в описании Get-кода, который подходит для данной функции: RSH_BUFFER_S8

Предупреждения
Память под данные должна быть выделена заранее, в программе пользователя. Внутри библиотеки UniDriver происходит только копирование в переданный буфер.

Сигнатура функции из RshUniDriver.dll:

unsigned __stdcall UniDriverLVGetArrayChar(unsigned int deviceHandle, unsigned int mode, unsigned int size, unsigned int* received, char* data);

GetArrayDouble.vi

RshUniDriver_lvlib_GetArrayDoublec.png

Получение информации об устройстве или библиотеке (double* - массив).

Параметры VI:

Параметр Тип

Описание

deviceHandle
cu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi

size
cu32.png

Размер массива - максимальное количество элементов, которые можно скопировать в массив.

error in (no error)
cerrcodeclst.png

Контроль ошибок (вход)

mode
cu32.png

Одна из констант перечисления RSH_GET. Для данного VI подходят константы, в описании которых указан тип данных RSH_BUFFER_DOUBLE

data in
c1ddbl.png

Массив, в который будут помещены данные

function return
iu32.png

Возвращаемое значение - RSH_API_SUCCESS или код ошибки.

error out
ierrcodeclst.png

Контроль ошибок (выход)

data out
i1ddbl.png

Заполненный данными (выходной) массив

deviceHandle out
iu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi (выход).

Значение данного параметра не меняется в процессе выполнения, и нужно только для контроля за потоком выполнения программы в LabVIEW (последовательность вызова VI).

Описание функции:

Аргументы
[in]deviceHandleИдентификатор драйвера устройства, полученный в результате вызова функции UniDriverGetDeviceHandle()
[in]modeОдна из констант перечисления RSH_GET
[in]sizeРазмер массива - максимальное количество элементов, которые можно скопировать в массив, указатель на который передается в параметре data.
[in,out]receivedПосле успешного выполнения функции в даннной переменной будет возвращено количество фактически скопированных элементов.
[in,out]dataУказатель на массив, в который будут скопированы данные
Возвращает
RSH_API_SUCCESS или код ошибки.

Данная функция - аналог функции UniDriverGet(). Отличие в том, что для передачи данных не используется специальная структура данных - можно просто передать указатель на массив нужного типа.
Тип данных, указанный в описании Get-кода, который подходит для данной функции: RSH_BUFFER_DOUBLE

Предупреждения
Память под данные должна быть выделена заранее, в программе пользователя. Внутри библиотеки UniDriver происходит только копирование в переданный буфер.

Сигнатура функции из RshUniDriver.dll:

unsigned __stdcall UniDriverLVGetArrayDouble(unsigned int deviceHandle, unsigned int mode, unsigned int size, unsigned int* received, double* data);

GetArrayInt.vi

RshUniDriver_lvlib_GetArrayIntc.png

Получение информации об устройстве или библиотеке (int* - массив).

Параметры VI:

Параметр Тип

Описание

deviceHandle
cu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi

size
cu32.png

Размер массива - максимальное количество элементов, которые можно скопировать в массив.

error in (no error)
cerrcodeclst.png

Контроль ошибок (вход)

mode
cu32.png

Одна из констант перечисления RSH_GET. Для данного VI подходят константы, в описании которых указан тип данных RSH_BUFFER_S32

data in
c1di32.png

Массив, в который будут помещены данные

function return
iu32.png

Возвращаемое значение - RSH_API_SUCCESS или код ошибки.

error out
ierrcodeclst.png

Контроль ошибок (выход)

data out
i1di32.png

Заполненный данными (выходной) массив

deviceHandle out
iu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi (выход).

Значение данного параметра не меняется в процессе выполнения, и нужно только для контроля за потоком выполнения программы в LabVIEW (последовательность вызова VI).

Описание функции:

Аргументы
[in]deviceHandleИдентификатор драйвера устройства, полученный в результате вызова функции UniDriverGetDeviceHandle()
[in]modeОдна из констант перечисления RSH_GET
[in]sizeРазмер массива - максимальное количество элементов, которые можно скопировать в массив, указатель на который передается в параметре data.
[in,out]receivedПосле успешного выполнения функции в даннной переменной будет возвращено количество фактически скопированных элементов.
[in,out]dataУказатель на массив, в который будут скопированы данные
Возвращает
RSH_API_SUCCESS или код ошибки.

Данная функция - аналог функции UniDriverGet(). Отличие в том, что для передачи данных не используется специальная структура данных - можно просто передать указатель на массив нужного типа.
Тип данных, указанный в описании Get-кода, который подходит для данной функции: RSH_BUFFER_S32

Предупреждения
Память под данные должна быть выделена заранее, в программе пользователя. Внутри библиотеки UniDriver происходит только копирование в переданный буфер.

Сигнатура функции из RshUniDriver.dll:

unsigned __stdcall UniDriverLVGetArrayInt(unsigned int deviceHandle, unsigned int mode, unsigned int size, unsigned int* received, int* data);

GetArrayShort.vi

RshUniDriver_lvlib_GetArrayShortc.png

Получение информации об устройстве или библиотеке (short* - массив).

Параметры VI:

Параметр Тип

Описание

deviceHandle
cu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi

size
cu32.png

Размер массива - максимальное количество элементов, которые можно скопировать в массив.

error in (no error)
cerrcodeclst.png

Контроль ошибок (вход)

mode
cu32.png

Одна из констант перечисления RSH_GET. Для данного VI подходят константы, в описании которых указан тип данных RSH_BUFFER_S16

data in
c1di16.png

Массив, в который будут помещены данные

function return
iu32.png

Возвращаемое значение - RSH_API_SUCCESS или код ошибки.

error out
ierrcodeclst.png

Контроль ошибок (выход)

data out
i1di16.png

Заполненный данными (выходной) массив

deviceHandle out
iu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi (выход).

Значение данного параметра не меняется в процессе выполнения, и нужно только для контроля за потоком выполнения программы в LabVIEW (последовательность вызова VI).

Описание функции:

Аргументы
[in]deviceHandleИдентификатор драйвера устройства, полученный в результате вызова функции UniDriverGetDeviceHandle()
[in]modeОдна из констант перечисления RSH_GET
[in]sizeРазмер массива - максимальное количество элементов, которые можно скопировать в массив, указатель на который передается в параметре data.
[in,out]receivedПосле успешного выполнения функции в даннной переменной будет возвращено количество фактически скопированных элементов.
[in,out]dataУказатель на массив, в который будут скопированы данные
Возвращает
RSH_API_SUCCESS или код ошибки.

Данная функция - аналог функции UniDriverGet(). Отличие в том, что для передачи данных не используется специальная структура данных - можно просто передать указатель на массив нужного типа.
Тип данных, указанный в описании Get-кода, который подходит для данной функции: RSH_BUFFER_S16

Предупреждения
Память под данные должна быть выделена заранее, в программе пользователя. Внутри библиотеки UniDriver происходит только копирование в переданный буфер.

Сигнатура функции из RshUniDriver.dll:

unsigned __stdcall UniDriverLVGetArrayShort(unsigned int deviceHandle, unsigned int mode,unsigned int size, unsigned int* received, short* data);

GetArrayUnsignedChar.vi

RshUniDriver_lvlib_GetArrayUnsignedCharc.png

Получение информации об устройстве или библиотеке (unsigned char* - массив).

Параметры VI:

Параметр Тип

Описание

deviceHandle
cu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi

size
cu32.png

Размер массива - максимальное количество элементов, которые можно скопировать в массив.

error in (no error)
cerrcodeclst.png

Контроль ошибок (вход)

mode
cu32.png

Одна из констант перечисления RSH_GET. Для данного VI подходят константы, в описании которых указан тип данных RSH_BUFFER_U8

data in
c1du8.png

Массив, в который будут помещены данные

function return
iu32.png

Возвращаемое значение - RSH_API_SUCCESS или код ошибки.

error out
ierrcodeclst.png

Контроль ошибок (выход)

data out
i1du8.png

Заполненный данными (выходной) массив

deviceHandle out
iu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi (выход).

Значение данного параметра не меняется в процессе выполнения, и нужно только для контроля за потоком выполнения программы в LabVIEW (последовательность вызова VI).

Описание функции:

Аргументы
[in]deviceHandleИдентификатор драйвера устройства, полученный в результате вызова функции UniDriverGetDeviceHandle()
[in]modeОдна из констант перечисления RSH_GET
[in]sizeРазмер массива - максимальное количество элементов, которые можно скопировать в массив, указатель на который передается в параметре data.
[in,out]receivedПосле успешного выполнения функции в даннной переменной будет возвращено количество фактически скопированных элементов.
[in,out]dataУказатель на массив, в который будут скопированы данные
Возвращает
RSH_API_SUCCESS или код ошибки.

Данная функция - аналог функции UniDriverGet(). Отличие в том, что для передачи данных не используется специальная структура данных - можно просто передать указатель на массив нужного типа.
Тип данных, указанный в описании Get-кода, который подходит для данной функции: RSH_BUFFER_U8

Предупреждения
Память под данные должна быть выделена заранее, в программе пользователя. Внутри библиотеки UniDriver происходит только копирование в переданный буфер.

Сигнатура функции из RshUniDriver.dll:

unsigned __stdcall UniDriverLVGetArrayUChar(unsigned int deviceHandle, unsigned int mode, unsigned int size, unsigned int* received, unsigned char* data);

GetArrayUnsignedInt.vi

RshUniDriver_lvlib_GetArrayUnsignedIntc.png

Получение информации об устройстве или библиотеке (unsigned int* - массив).

Параметры VI:

Параметр Тип

Описание

deviceHandle
cu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi

size
cu32.png

Размер массива - максимальное количество элементов, которые можно скопировать в массив.

error in (no error)
cerrcodeclst.png

Контроль ошибок (вход)

mode
cu32.png

Одна из констант перечисления RSH_GET. Для данного VI подходят константы, в описании которых указан тип данных RSH_BUFFER_U32

data in
c1du32.png

Массив, в который будут помещены данные

function return
iu32.png

Возвращаемое значение - RSH_API_SUCCESS или код ошибки.

error out
ierrcodeclst.png

Контроль ошибок (выход)

data out
i1du32.png

Заполненный данными (выходной) массив

deviceHandle out
iu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi (выход).

Значение данного параметра не меняется в процессе выполнения, и нужно только для контроля за потоком выполнения программы в LabVIEW (последовательность вызова VI).

Описание функции:

Аргументы
[in]deviceHandleИдентификатор драйвера устройства, полученный в результате вызова функции UniDriverGetDeviceHandle()
[in]modeОдна из констант перечисления RSH_GET
[in]sizeРазмер массива - максимальное количество элементов, которые можно скопировать в массив, указатель на который передается в параметре data.
[in,out]receivedПосле успешного выполнения функции в даннной переменной будет возвращено количество фактически скопированных элементов.
[in,out]dataУказатель на массив, в который будут скопированы данные
Возвращает
RSH_API_SUCCESS или код ошибки.

Данная функция - аналог функции UniDriverGet(). Отличие в том, что для передачи данных не используется специальная структура данных - можно просто передать указатель на массив нужного типа.
Тип данных, указанный в описании Get-кода, который подходит для данной функции: RSH_BUFFER_U32

Предупреждения
Память под данные должна быть выделена заранее, в программе пользователя. Внутри библиотеки UniDriver происходит только копирование в переданный буфер.

Сигнатура функции из RshUniDriver.dll:

unsigned __stdcall UniDriverLVGetArrayUInt(unsigned int deviceHandle, unsigned int mode, unsigned int size, unsigned int* received, unsigned int* data);

GetArrayUnsignedShort.vi

RshUniDriver_lvlib_GetArrayUnsignedShortc.png

Получение информации об устройстве или библиотеке (unsigned short* - массив).

Параметры VI:

Параметр Тип

Описание

deviceHandle
cu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi

size
cu32.png

Размер массива - максимальное количество элементов, которые можно скопировать в массив.

error in (no error)
cerrcodeclst.png

Контроль ошибок (вход)

mode
cu32.png

Одна из констант перечисления RSH_GET. Для данного VI подходят константы, в описании которых указан тип данных RSH_BUFFER_U16

data in
c1du16.png

Массив, в который будут помещены данные

function return
iu32.png

Возвращаемое значение - RSH_API_SUCCESS или код ошибки.

error out
ierrcodeclst.png

Контроль ошибок (выход)

data out
i1du16.png

Заполненный данными (выходной) массив

deviceHandle out
iu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi (выход).

Значение данного параметра не меняется в процессе выполнения, и нужно только для контроля за потоком выполнения программы в LabVIEW (последовательность вызова VI).

Описание функции:

Аргументы
[in]deviceHandleИдентификатор драйвера устройства, полученный в результате вызова функции UniDriverGetDeviceHandle()
[in]modeОдна из констант перечисления RSH_GET
[in]sizeРазмер массива - максимальное количество элементов, которые можно скопировать в массив, указатель на который передается в параметре data.
[in,out]receivedПосле успешного выполнения функции в даннной переменной будет возвращено количество фактически скопированных элементов.
[in,out]dataУказатель на массив, в который будут скопированы данные
Возвращает
RSH_API_SUCCESS или код ошибки.

Данная функция - аналог функции UniDriverGet(). Отличие в том, что для передачи данных не используется специальная структура данных - можно просто передать указатель на массив нужного типа.
Тип данных, указанный в описании Get-кода, который подходит для данной функции: RSH_BUFFER_U16

Предупреждения
Память под данные должна быть выделена заранее, в программе пользователя. Внутри библиотеки UniDriver происходит только копирование в переданный буфер.

Сигнатура функции из RshUniDriver.dll:

unsigned __stdcall UniDriverLVGetArrayUShort(unsigned int deviceHandle, unsigned int mode, unsigned int size, unsigned int* received, unsigned short* data);

IRshDevice::Get()

Для получения данных (информации) об устройстве и библиотеке абстракции в библиотеке RshUniDriver.dll используется ряд функций, которые являются аналогами метода IRshDevice::Get(), но при этом жестко типизированы.

GetDouble.vi

RshUniDriver_lvlib_GetDoublec.png

Получение информации об устройстве или библиотеке (double).

Параметры VI:

Параметр Тип

Описание

deviceHandle
cu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi

error in (no error)
cerrcodeclst.png

Контроль ошибок (вход)

mode
cu32.png

Одна из констант перечисления RSH_GET. Для данного VI подходят константы, в описании которых указан тип данных RSH_DOUBLE

value in
cdbl.png

Входные данные. Иногда нужно передать какое-либо значение в библиотеку абстракции, а не прочитать его. В этом случае нужно задать значение, иначе данный параметр можно игнорировать.

function return
iu32.png

Возвращаемое значение - RSH_API_SUCCESS или код ошибки.

error out
ierrcodeclst.png

Контроль ошибок (выход)

value out
idbl.png

Выходные данные. Полученное в результате выполнения функции значение.

deviceHandle out
iu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi (выход).

Значение данного параметра не меняется в процессе выполнения, и нужно только для контроля за потоком выполнения программы в LabVIEW (последовательность вызова VI).

Описание функции:

Аргументы
[in]deviceHandleИдентификатор драйвера устройства, полученный в результате вызова функции UniDriverGetDeviceHandle()
[in]modeОдна из констант перечисления RSH_GET
[in,out]valueУказатель на переменную, в которую будут помещены данные.
Возвращает
RSH_API_SUCCESS или код ошибки.

Данная функция - аналог функции UniDriverGet(). Отличие в том, что для передачи данных не используется специальная структура данных - можно просто передать указатель на переменную нужного типа.
Тип данных, указанный в описании Get-кода, который подходит для данной функции: RSH_DOUBLE

Предупреждения
Память под данные должна быть выделена заранее, в программе пользователя.

Сигнатура функции из RshUniDriver.dll:

unsigned __stdcall UniDriverLVGetDouble(unsigned int deviceHandle, unsigned int mode, double* value);

GetChar.vi

RshUniDriver_lvlib_GetCharc.png

Получение информации об устройстве или библиотеке (char).

Параметры VI:

Параметр Тип

Описание

deviceHandle
cu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi

error in (no error)
cerrcodeclst.png

Контроль ошибок (вход)

mode
cu32.png

Одна из констант перечисления RSH_GET. Для данного VI подходят константы, в описании которых указан тип данных RSH_S8

value in
ci8.png

Входные данные. Иногда нужно передать какое-либо значение в библиотеку абстракции, а не прочитать его. В этом случае нужно задать значение, иначе данный параметр можно игнорировать.

function return
iu32.png

Возвращаемое значение - RSH_API_SUCCESS или код ошибки.

error out
ierrcodeclst.png

Контроль ошибок (выход)

value out
ii8.png

Выходные данные. Полученное в результате выполнения функции значение.

deviceHandle out
iu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi (выход).

Значение данного параметра не меняется в процессе выполнения, и нужно только для контроля за потоком выполнения программы в LabVIEW (последовательность вызова VI).

Описание функции:

Аргументы
[in]deviceHandleИдентификатор драйвера устройства, полученный в результате вызова функции UniDriverGetDeviceHandle()
[in]modeОдна из констант перечисления RSH_GET
[in,out]valueУказатель на переменную, в которую будут помещены данные.
Возвращает
RSH_API_SUCCESS или код ошибки.

Данная функция - аналог функции UniDriverGet(). Отличие в том, что для передачи данных не используется специальная структура данных - можно просто передать указатель на переменную нужного типа.
Тип данных, указанный в описании Get-кода, который подходит для данной функции: RSH_S8

Предупреждения
Память под данные должна быть выделена заранее, в программе пользователя.

Сигнатура функции из RshUniDriver.dll:

unsigned __stdcall UniDriverLVGetChar(unsigned int deviceHandle, unsigned int mode, char* value);

GetUnsignedChar.vi

RshUniDriver_lvlib_GetUnsignedCharc.png

Получение информации об устройстве или библиотеке (unsigned char).

Параметры VI:

Параметр Тип

Описание

deviceHandle
cu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi

error in (no error)
cerrcodeclst.png

Контроль ошибок (вход)

mode
cu32.png

Одна из констант перечисления RSH_GET. Для данного VI подходят константы, в описании которых указан тип данных RSH_U8

value in
cu8.png

Входные данные. Иногда нужно передать какое-либо значение в библиотеку абстракции, а не прочитать его. В этом случае нужно задать значение, иначе данный параметр можно игнорировать.

function return
iu32.png

Возвращаемое значение - RSH_API_SUCCESS или код ошибки.

error out
ierrcodeclst.png

Контроль ошибок (выход)

value out
iu8.png

Выходные данные. Полученное в результате выполнения функции значение.

deviceHandle out
iu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi (выход).

Значение данного параметра не меняется в процессе выполнения, и нужно только для контроля за потоком выполнения программы в LabVIEW (последовательность вызова VI).

Описание функции:

Аргументы
[in]deviceHandleИдентификатор драйвера устройства, полученный в результате вызова функции UniDriverGetDeviceHandle()
[in]modeОдна из констант перечисления RSH_GET
[in,out]valueУказатель на переменную, в которую будут помещены данные.
Возвращает
RSH_API_SUCCESS или код ошибки.

Данная функция - аналог функции UniDriverGet(). Отличие в том, что для передачи данных не используется специальная структура данных - можно просто передать указатель на переменную нужного типа.
Тип данных, указанный в описании Get-кода, который подходит для данной функции: RSH_U8

Предупреждения
Память под данные должна быть выделена заранее, в программе пользователя.

Сигнатура функции из RshUniDriver.dll:

unsigned __stdcall UniDriverLVGetUChar(unsigned int deviceHandle, unsigned int mode,unsigned char* value);

GetShort.vi

RshUniDriver_lvlib_GetShortc.png

Получение информации об устройстве или библиотеке (short).

Параметры VI:

Параметр Тип

Описание

deviceHandle
cu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi

error in (no error)
cerrcodeclst.png

Контроль ошибок (вход)

mode
cu32.png

Одна из констант перечисления RSH_GET. Для данного VI подходят константы, в описании которых указан тип данных RSH_S16

value in
ci16.png

Входные данные. Иногда нужно передать какое-либо значение в библиотеку абстракции, а не прочитать его. В этом случае нужно задать значение, иначе данный параметр можно игнорировать.

function return
iu32.png

Возвращаемое значение - RSH_API_SUCCESS или код ошибки.

error out
ierrcodeclst.png

Контроль ошибок (выход)

value out
ii16.png

Выходные данные. Полученное в результате выполнения функции значение.

deviceHandle out
iu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi (выход).

Значение данного параметра не меняется в процессе выполнения, и нужно только для контроля за потоком выполнения программы в LabVIEW (последовательность вызова VI).

Описание функции:

Аргументы
[in]deviceHandleИдентификатор драйвера устройства, полученный в результате вызова функции UniDriverGetDeviceHandle()
[in]modeОдна из констант перечисления RSH_GET
[in,out]valueУказатель на переменную, в которую будут помещены данные.
Возвращает
RSH_API_SUCCESS или код ошибки.

Данная функция - аналог функции UniDriverGet(). Отличие в том, что для передачи данных не используется специальная структура данных - можно просто передать указатель на переменную нужного типа.
Тип данных, указанный в описании Get-кода, который подходит для данной функции: RSH_S16

Предупреждения
Память под данные должна быть выделена заранее, в программе пользователя.

Сигнатура функции из RshUniDriver.dll:

unsigned __stdcall UniDriverLVGetShort(unsigned int deviceHandle, unsigned int mode, short* value);

GetUnsignedShort.vi

RshUniDriver_lvlib_GetUnsignedShortc.png

Получение информации об устройстве или библиотеке (unsigned short).

Параметры VI:

Параметр Тип

Описание

deviceHandle
cu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi

error in (no error)
cerrcodeclst.png

Контроль ошибок (вход)

mode
cu32.png

Одна из констант перечисления RSH_GET. Для данного VI подходят константы, в описании которых указан тип данных RSH_U16

value in
cu16.png

Входные данные. Иногда нужно передать какое-либо значение в библиотеку абстракции, а не прочитать его. В этом случае нужно задать значение, иначе данный параметр можно игнорировать.

function return
iu32.png

Возвращаемое значение - RSH_API_SUCCESS или код ошибки.

error out
ierrcodeclst.png

Контроль ошибок (выход)

value out
iu16.png

Выходные данные. Полученное в результате выполнения функции значение.

deviceHandle out
iu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi (выход).

Значение данного параметра не меняется в процессе выполнения, и нужно только для контроля за потоком выполнения программы в LabVIEW (последовательность вызова VI).

Описание функции:

Аргументы
[in]deviceHandleИдентификатор драйвера устройства, полученный в результате вызова функции UniDriverGetDeviceHandle()
[in]modeОдна из констант перечисления RSH_GET
[in,out]valueУказатель на переменную, в которую будут помещены данные.
Возвращает
RSH_API_SUCCESS или код ошибки.

Данная функция - аналог функции UniDriverGet(). Отличие в том, что для передачи данных не используется специальная структура данных - можно просто передать указатель на переменную нужного типа.
Тип данных, указанный в описании Get-кода, который подходит для данной функции: RSH_U16

Предупреждения
Память под данные должна быть выделена заранее, в программе пользователя.

Сигнатура функции из RshUniDriver.dll:

unsigned __stdcall UniDriverLVGetUShort(unsigned int deviceHandle, unsigned int mode,unsigned short* value);

GetInt.vi

RshUniDriver_lvlib_GetIntc.png

Получение информации об устройстве или библиотеке (int).

Параметры VI:

Параметр Тип

Описание

deviceHandle
cu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi

error in (no error)
cerrcodeclst.png

Контроль ошибок (вход)

mode
cu32.png

Одна из констант перечисления RSH_GET. Для данного VI подходят константы, в описании которых указан тип данных RSH_S32

value in
ci32.png

Входные данные. Иногда нужно передать какое-либо значение в библиотеку абстракции, а не прочитать его. В этом случае нужно задать значение, иначе данный параметр можно игнорировать.

function return
iu32.png

Возвращаемое значение - RSH_API_SUCCESS или код ошибки.

error out
ierrcodeclst.png

Контроль ошибок (выход)

value out
ii32.png

Выходные данные. Полученное в результате выполнения функции значение.

deviceHandle out
iu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi (выход).

Значение данного параметра не меняется в процессе выполнения, и нужно только для контроля за потоком выполнения программы в LabVIEW (последовательность вызова VI).

Описание функции:

Аргументы
[in]deviceHandleИдентификатор драйвера устройства, полученный в результате вызова функции UniDriverGetDeviceHandle()
[in]modeОдна из констант перечисления RSH_GET
[in,out]valueУказатель на переменную, в которую будут помещены данные.
Возвращает
RSH_API_SUCCESS или код ошибки.

Данная функция - аналог функции UniDriverGet(). Отличие в том, что для передачи данных не используется специальная структура данных - можно просто передать указатель на переменную нужного типа.
Тип данных, указанный в описании Get-кода, который подходит для данной функции: RSH_S32

Предупреждения
Память под данные должна быть выделена заранее, в программе пользователя.

Сигнатура функции из RshUniDriver.dll:

unsigned __stdcall UniDriverLVGetInt(unsigned int deviceHandle, unsigned int mode, int* value);

GetUnsignedInt.vi

RshUniDriver_lvlib_GetUnsignedIntc.png

Получение информации об устройстве или библиотеке (unsigned int).

Параметры VI:

Параметр Тип

Описание

deviceHandle
cu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi

error in (no error)
cerrcodeclst.png

Контроль ошибок (вход)

mode
cu32.png

Одна из констант перечисления RSH_GET. Для данного VI подходят константы, в описании которых указан тип данных RSH_U32

value in
cu16.png

Входные данные. Иногда нужно передать какое-либо значение в библиотеку абстракции, а не прочитать его. В этом случае нужно задать значение, иначе данный параметр можно игнорировать.

function return
iu32.png

Возвращаемое значение - RSH_API_SUCCESS или код ошибки.

error out
ierrcodeclst.png

Контроль ошибок (выход)

value out
iu32.png

Выходные данные. Полученное в результате выполнения функции значение.

deviceHandle out
iu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi (выход).

Значение данного параметра не меняется в процессе выполнения, и нужно только для контроля за потоком выполнения программы в LabVIEW (последовательность вызова VI).

Описание функции:

Аргументы
[in]deviceHandleИдентификатор драйвера устройства, полученный в результате вызова функции UniDriverGetDeviceHandle()
[in]modeОдна из констант перечисления RSH_GET
[in,out]valueУказатель на переменную, в которую будут помещены данные.
Возвращает
RSH_API_SUCCESS или код ошибки.

Данная функция - аналог функции UniDriverGet(). Отличие в том, что для передачи данных не используется специальная структура данных - можно просто передать указатель на переменную нужного типа.
Тип данных, указанный в описании Get-кода, который подходит для данной функции: RSH_U32

Предупреждения
Память под данные должна быть выделена заранее, в программе пользователя.

Сигнатура функции из RshUniDriver.dll:

unsigned __stdcall UniDriverLVGetUInt(unsigned int deviceHandle, unsigned int mode,unsigned int* value);

GetCString.vi

RshUniDriver_lvlib_GetCStringc.png

Получение информации об устройстве или библиотеке (char* - строка).

Параметры VI:

Параметр Тип

Описание

deviceHandle
cu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi

error in (no error)
cerrcodeclst.png

Контроль ошибок (вход)

mode
cu32.png

Одна из констант перечисления RSH_GET. Для данного VI подходят константы, в описании которых указан тип данных RSH_S8P

value in
cstr.png

Входные данные. Иногда нужно передать какое-либо значение в библиотеку абстракции, а не прочитать его. В этом случае нужно задать значение, иначе данный параметр можно игнорировать.

function return
iu32.png

Возвращаемое значение - RSH_API_SUCCESS или код ошибки.

error out
ierrcodeclst.png

Контроль ошибок (выход)

value out
istr.png

Выходные данные. Полученное в результате выполнения функции значение.

deviceHandle out
iu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi (выход).

Значение данного параметра не меняется в процессе выполнения, и нужно только для контроля за потоком выполнения программы в LabVIEW (последовательность вызова VI).

Описание функции:

Аргументы
[in]deviceHandleИдентификатор драйвера устройства, полученный в результате вызова функции UniDriverGetDeviceHandle()
[in]modeОдна из констант перечисления RSH_GET
[in,out]valueУказатель на массив, в который будут помещены данные.
[in]maxLengthМаксимальный размер строки (должен быть равен размеру выделенной памяти в буфере value).
Возвращает
RSH_API_SUCCESS или код ошибки.

Данная функция - аналог функции UniDriverGet(). Отличие в том, что для передачи данных не используется специальная структура данных - можно просто передать указатель на переменную нужного типа.
Тип данных, указанный в описании Get-кода, который подходит для данной функции: RSH_S8P

Предупреждения
Память под данные должна быть выделена заранее, в программе пользователя. Внутри библиотеки UniDriver происходит только копирование в переданный буфер.

Сигнатура функции из RshUniDriver.dll:

unsigned __stdcall UniDriverLVGetCstr(unsigned int deviceHandle, unsigned int mode, char* value);

IRshDevice::GetData - получение данных

Для получения буфера данных в библиотеке RshUniDriver.dll используется ряд функций, которые являются аналогами метода IRshDevice::GetData(), но при этом жестко типизированы.

GetDataChar.vi

RshUniDriver_lvlib_GetDataCharc.png

Получение (передача) буфера с данными (массив char*)

Параметры VI:

Параметр Тип

Описание

deviceHandle
cu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi

getDataMode
cu32.png

Дополнительные параметры (одна из констант перечисления RSH_DATA_MODES). Используйте RSH_DATA_MODE_NO_FLAGS если не требуется выполнять каких-либо дополнительных действий с данными в буфере.

size
cu32.png

Размер массива - максимальное количество элементов, которые можно скопировать в массив

error in (no error)
cerrcodeclst.png

Контроль ошибок (вход)

function return
iu32.png

Возвращаемое значение - RSH_API_SUCCESS или код ошибки.

error out
ierrcodeclst.png

Контроль ошибок (выход)

deviceHandle out
iu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi (выход).

Значение данного параметра не меняется в процессе выполнения, и нужно только для контроля за потоком выполнения программы в LabVIEW (последовательность вызова VI).

buffer
i1di8.png
Заполненный данными буфер. Размер массива равен фактическому количеству скопированных элементов.

Описание функции:

Аргументы
[in]deviceHandleИдентификатор драйвера устройства, полученный в результате вызова функции UniDriverGetDeviceHandle()
[in]getDataModeДополнительные параметры (одна из констант перечисления RSH_DATA_MODES). Используйте RSH_DATA_MODE_NO_FLAGS если не требуется выполнять каких-либо дополнительных действий с данными в буфере.
[in]sizeРазмер массива - максимальное количество элементов, которые можно скопировать в массив, указатель на который передается в параметре buffer.
[in,out]receivedПосле успешного выполнения функции в даннной переменной будет возвращено количество фактически скопированных элементов.
[in,out]bufferУказатель на массив, в который будут скопированы данные
Возвращает
RSH_API_SUCCESS или код ошибки.

Данная функция - аналог функции UniDriverGetData(). Отличие в том, что для передачи данных не используется специальная структура данных - можно просто передать указатель на массив нужного типа.

Предупреждения
Память под данные должна быть выделена заранее, в программе пользователя. Внутри библиотеки UniDriver происходит только копирование в переданный буфер.

Сигнатура функции из RshUniDriver.dll:

unsigned __stdcall UniDriverLVGetDataChar(unsigned int deviceHandle, unsigned int getDataMode,unsigned int size, unsigned int* received, char* buffer);

GetDataDouble.vi

RshUniDriver_lvlib_GetDataDoublec.png

Получение (передача) буфера с данными (массив double*)

Параметры VI:

Параметр Тип

Описание

deviceHandle
cu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi

getDataMode
cu32.png

Дополнительные параметры (одна из констант перечисления RSH_DATA_MODES). Используйте RSH_DATA_MODE_NO_FLAGS если не требуется выполнять каких-либо дополнительных действий с данными в буфере.

size
cu32.png

Размер массива - максимальное количество элементов, которые можно скопировать в массив

error in (no error)
cerrcodeclst.png

Контроль ошибок (вход)

function return
iu32.png

Возвращаемое значение - RSH_API_SUCCESS или код ошибки.

error out
ierrcodeclst.png

Контроль ошибок (выход)

deviceHandle out
iu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi (выход).

Значение данного параметра не меняется в процессе выполнения, и нужно только для контроля за потоком выполнения программы в LabVIEW (последовательность вызова VI).

buffer
i1ddbl.png
Заполненный данными буфер. Размер массива равен фактическому количеству скопированных элементов.

Описание функции:

Аргументы
[in]deviceHandleИдентификатор драйвера устройства, полученный в результате вызова функции UniDriverGetDeviceHandle()
[in]getDataModeДополнительные параметры (одна из констант перечисления RSH_DATA_MODES). Используйте RSH_DATA_MODE_NO_FLAGS если не требуется выполнять каких-либо дополнительных действий с данными в буфере.
[in]sizeРазмер массива - максимальное количество элементов, которые можно скопировать в массив, указатель на который передается в параметре buffer.
[in,out]receivedПосле успешного выполнения функции в даннной переменной будет возвращено количество фактически скопированных элементов.
[in,out]bufferУказатель на массив, в который будут скопированы данные
Возвращает
RSH_API_SUCCESS или код ошибки.

Данная функция - аналог функции UniDriverGetData(). Отличие в том, что для передачи данных не используется специальная структура данных - можно просто передать указатель на массив нужного типа.

Предупреждения
Память под данные должна быть выделена заранее, в программе пользователя. Внутри библиотеки UniDriver происходит только копирование в переданный буфер.

Сигнатура функции из RshUniDriver.dll:

unsigned __stdcall UniDriverLVGetDataDouble(unsigned int deviceHandle, unsigned int getDataMode,unsigned int size, unsigned int* received, double* buffer);

GetDataShort.vi

RshUniDriver_lvlib_GetDataShortc.png

Получение (передача) буфера с данными (массив short*)

Параметры VI:

Параметр Тип

Описание

deviceHandle
cu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi

getDataMode
cu32.png

Дополнительные параметры (одна из констант перечисления RSH_DATA_MODES). Используйте RSH_DATA_MODE_NO_FLAGS если не требуется выполнять каких-либо дополнительных действий с данными в буфере.

size
cu32.png

Размер массива - максимальное количество элементов, которые можно скопировать в массив

error in (no error)
cerrcodeclst.png

Контроль ошибок (вход)

function return
iu32.png

Возвращаемое значение - RSH_API_SUCCESS или код ошибки.

error out
ierrcodeclst.png

Контроль ошибок (выход)

deviceHandle out
iu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi (выход).

Значение данного параметра не меняется в процессе выполнения, и нужно только для контроля за потоком выполнения программы в LabVIEW (последовательность вызова VI).

buffer
i1di16.png
Заполненный данными буфер. Размер массива равен фактическому количеству скопированных элементов.

Описание функции:

Аргументы
[in]deviceHandleИдентификатор драйвера устройства, полученный в результате вызова функции UniDriverGetDeviceHandle()
[in]getDataModeДополнительные параметры (одна из констант перечисления RSH_DATA_MODES). Используйте RSH_DATA_MODE_NO_FLAGS если не требуется выполнять каких-либо дополнительных действий с данными в буфере.
[in]sizeРазмер массива - максимальное количество элементов, которые можно скопировать в массив, указатель на который передается в параметре buffer.
[in,out]receivedПосле успешного выполнения функции в даннной переменной будет возвращено количество фактически скопированных элементов.
[in,out]bufferУказатель на массив, в который будут скопированы данные
Возвращает
RSH_API_SUCCESS или код ошибки.

Данная функция - аналог функции UniDriverGetData(). Отличие в том, что для передачи данных не используется специальная структура данных - можно просто передать указатель на массив нужного типа.

Предупреждения
Память под данные должна быть выделена заранее, в программе пользователя. Внутри библиотеки UniDriver происходит только копирование в переданный буфер.

Сигнатура функции из RshUniDriver.dll:

unsigned __stdcall UniDriverLVGetDataShort(unsigned int deviceHandle, unsigned int getDataMode,unsigned int size, unsigned int* received, short* buffer);

GetDataInt.vi

RshUniDriver_lvlib_GetDataIntc.png

Получение (передача) буфера с данными (массив int*)

Параметры VI:

Параметр Тип

Описание

deviceHandle
cu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi

getDataMode
cu32.png

Дополнительные параметры (одна из констант перечисления RSH_DATA_MODES). Используйте RSH_DATA_MODE_NO_FLAGS если не требуется выполнять каких-либо дополнительных действий с данными в буфере.

size
cu32.png

Размер массива - максимальное количество элементов, которые можно скопировать в массив

error in (no error)
cerrcodeclst.png

Контроль ошибок (вход)

function return
iu32.png

Возвращаемое значение - RSH_API_SUCCESS или код ошибки.

error out
ierrcodeclst.png

Контроль ошибок (выход)

deviceHandle out
iu32.png

Идентификатор драйвера устройства, полученный в результате вызова модуля GetDeviceHandle.vi (выход).

Значение данного параметра не меняется в процессе выполнения, и нужно только для контроля за потоком выполнения программы в LabVIEW (последовательность вызова VI).

buffer
i1di32.png
Заполненный данными буфер. Размер массива равен фактическому количеству скопированных элементов.

Описание функции:

Аргументы
[in]deviceHandleИдентификатор драйвера устройства, полученный в результате вызова функции UniDriverGetDeviceHandle()
[in]getDataModeДополнительные параметры (одна из констант перечисления RSH_DATA_MODES). Используйте RSH_DATA_MODE_NO_FLAGS если не требуется выполнять каких-либо дополнительных действий с данными в буфере.
[in]sizeРазмер массива - максимальное количество элементов, которые можно скопировать в массив, указатель на который передается в параметре buffer.
[in,out]receivedПосле успешного выполнения функции в даннной переменной будет возвращено количество фактически скопированных элементов.
[in,out]bufferУказатель на массив, в который будут скопированы данные
Возвращает
RSH_API_SUCCESS или код ошибки.

Данная функция - аналог функции UniDriverGetData(). Отличие в том, что для передачи данных не используется специальная структура данных - можно просто передать указатель на массив нужного типа.

Предупреждения
Память под данные должна быть выделена заранее, в программе пользователя. Внутри библиотеки UniDriver происходит только копирование в переданный буфер.

Сигнатура функции из RshUniDriver.dll:

unsigned __stdcall UniDriverLVGetDataInt(unsigned int deviceHandle, unsigned int getDataMode,unsigned int size, unsigned int* received, int* buffer);

Конструкторы

В данном разделе описываются VI, которые служат для формирования структур данных - заполнение структур (кластеров), формирование управляющих слов и т.п.

RshChannelParams.vi

RshUniDriver_lvlib_RshChannelParamsc.png

Данный модуль используется для формирования кластера RshChannel.clb

Параметры VI:

Параметр Тип

Описание

Use
cu32.png

Использовать или нет данный канал при сборе данных

Synchro
cu32.png

Использовать или нет данный канал в качестве источника синхронизации

Resist
cu32.png

Входное сопротивление аналогового канала

Coupling
cu32.png

Открыть или закрыть вход (актуально только при использовании 1МОм входа)

adjustment
cdbl.png

Подстройка (смещение) уровня входного напряжения для данного канала. Данный параметр задается в вольтах. См. также RSH_CAPS_DEVICE_INPUT_LEVEL_ADJUSTMENT

gain
cu32.png
Коэффициент усиления, который будет использован для данного канала при сборе данных

RshControlDMAParams.vi

RshUniDriver_lvlib_RshControlDMAParamsc.png

Данный модуль используется для формирования управляющего слова, которое используется в структуре инициализации RshInitDMA (кластер RshInitDMA.clb)

Параметры VI:

Параметр Тип

Описание

DiffMode
cbool.png

Переключение между дифференциальным и однополюсным режимами работы

FrameMode
cbool.png

Включение или выключение кадрового сбора

MulSwitchStart
cbool.png

Выбор момента переключения мультиплексора (не используется в данный момент, возможно будет удалено в следующих релизах!)

Control
iu32.png
Сформированное управляющее слово (можно передать в поле Control структуры инициализации RshInitDMA)

RshControlMemoryParams.vi

RshUniDriver_lvlib_RshControlMemoryParamsc.png

Данный модуль используется для формирования управляющего слова, которое используется в структуре инициализации RshInitMemory (кластер RshInitMemory.clb)

Параметры VI:

Параметр Тип

Описание

FreqMode
cu32.png

Выбор одного из режимов работы: стандартный, удвоение частоты, учетверение частоты

Control
iu32.png
Результат - сформированное управляющее слово

RshControlSynchroParams.vi

RshUniDriver_lvlib_RshControlSynchroParamsc.png

Данный модуль используется для формирования управляющего слова с дополнительными параметрами внешней синхронизации (поле ControlSynchro структуры инициализации RshInitMemory.clb)

Параметры VI:

Параметр Тип

Описание

Slope
cu32.png

Выбор способа синхронизации: по фронту или по спаду сигнала

FrequencySwitch
cu32.png

Использование переключения частоты дискретизации для предыстории/истории. Если включено, "история" и "предыстория" сигнала будут писаться с разными частотами дискретизации.

Control
iu32.png

Сформированное управляющее слово


RshSynchroChannelParams.vi

RshUniDriver_lvlib_RshSynchroChannelParamsc.png

Данный модуль используется для заполнения кластера RshSynchroChannel.ctl

Параметры VI:

Параметр Тип

Описание

Filter
cu32.png

Использование фильтра для входа внешней синхронизации

Resist
cu32.png

Входное сопротивления для канала внешней синхронизации.

Coupling
cu32.png

Переключение состояния входа внешней синхронизации "открытый"/"закрытый" (актуально только при использовании 1МОм входа)

gain
cu32.png

Коэффициент усиления для входа внешней синхронизации

Synchro Channel
inclst.png
Заполненная структура (кластер) с параметрами входа внешней синхронизации