функция ACX_REQUEST_PARAMETERS_INIT_METHOD (acxrequest.h)

2025-02-06

Функция ACX_REQUEST_PARAMETERS_INIT_METHOD инициализирует структуру ACX_REQUEST_PARAMETERS с параметрами метода ACX.

Синтаксис

void ACX_REQUEST_PARAMETERS_INIT_METHOD(
  PACX_REQUEST_PARAMETERS Params,
  const GUID              Set,
  ULONG                   Id,
  ACX_METHOD_VERB         Verb,
  ACX_ITEM_TYPE           ItemType,
  ULONG                   ItemId,
  PVOID                   Args,
  ULONG                   ArgsCb,
  PVOID                   Result,
  ULONG                   ResultCb
);

Параметры

Params

Указатель на ACX_REQUEST_PARAMETERS структуру, используемую для хранения параметров метода.

Set

Идентификатор набора методов (GUID).

Id

Идентификатор метода (ULONG) в идентификаторе набора методов.

Verb

Команда метода ACX для отправки в соответствии с перечислением ACX_METHOD_VERB.

ItemType

Тип отправленного элемента ACX_ITEM_TYPE, например AcxItemTypeCircuit.

ItemId

Идентификатор элемента объекта ItemType, например идентификатор пин-кода, если элемент ItemType является закреплением.

Args

Необязательный буфер Args, содержащий дополнительные параметры для указанного метода. Установите значение NULL, если нет.

ArgsCb

Количество байтов (размер) буфера Args. Установите значение 0, если поле Args не используется.

Result

Необязательный буфер результатов для старого результата операции. Установите значение NULL, если оно отсутствует или если *SendMethod необходимо выделить его, если ResultCb не равен нулю. Вызывающий объект отвечает за освобождение выделенного буфера.

ResultCb

Количество в байтах (размер) буфера результатов. Установите значение 0, если результат не используется.

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

Никакой

Замечания

Пример

Ниже показан пример использования.

            arg     = circuitArg;
            result  = 0;

            //
            // Format and send the request.
            //
            ACX_REQUEST_PARAMETERS_INIT_METHOD(
                &params,
                methodsTests[i].MethodSet,
                methodsTests[i].MethodId,
                AcxMethodVerbSend,
                AcxItemTypeCircuit,
                AcxItemIdNone,
                &arg, sizeof(arg),      // Args & size
                &result, sizeof(result) // Result & size
                );

Требования к ACX

минимальная версия ACX: 1.0

Дополнительные сведения о версиях ACX см. в обзоре версий ACX.

Требования

Требование	Ценность
заголовка	acxrequest.h

См. также

заголовка acxrequest.h