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

Статья
10/06/2023

Функция 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) в идентификаторе set метода.

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, если результат не используется.

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

None

Remarks

Пример

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

            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] (index.md)