Функция SerCx2CustomReceiveTransactionCreate (sercx.h)

Статья
10/30/2024

Метод SerCx2CustomReceiveTransactionCreate создает объект custom-receive-transaction, который версии 2 расширения последовательной платформы (SerCx2) использует для выполнения пользовательских транзакций получения.

Синтаксис

NTSTATUS SerCx2CustomReceiveTransactionCreate(
  [in]  SERCX2CUSTOMRECEIVE                       CustomReceive,
  [in]  PSERCX2_CUSTOM_RECEIVE_TRANSACTION_CONFIG CustomReceiveTransactionConfig,
  [in]  PWDF_OBJECT_ATTRIBUTES                    Attributes,
  [out] SERCX2CUSTOMRECEIVETRANSACTION            *CustomReceiveTransaction
);

Параметры

[in] CustomReceive

Дескриптор SERCX2CUSTOMRECEIVE для объекта пользовательского получения. Драйвер последовательного контроллера ранее вызвал метод SerCx2CustomReceiveCreate для создания этого объекта.

[in] CustomReceiveTransactionConfig

Указатель на структуру SERCX2_CUSTOM_RECEIVE_TRANSACTION_CONFIG. Перед вызовом этого метода вызывающий объект должен вызвать функцию SERCX2_CUSTOM_RECEIVE_TRANSACTION_CONFIG_INIT для инициализации структуры. Эта структура содержит указатели на набор подпрограмм обратного вызова событий, реализованных драйвером последовательного контроллера. SerCx2 вызывает эти функции для выполнения транзакции ввода-вывода, которая использует пользовательский механизм передачи данных для чтения данных, полученных последовательным контроллером.

[in] Attributes

Указатель на структуру WDF_OBJECT_ATTRIBUTES, описывающую атрибуты для назначения новому объекту custom-receive-transaction. Перед вызовом этого метода вызывающий объект должен вызвать функцию WDF_OBJECT_ATTRIBUTES_INIT для инициализации структуры. Этот параметр является необязательным и может быть указан как WDF_NO_OBJECT_ATTRIBUTES если драйвер последовательного контроллера не должен назначать атрибуты объекту. Дополнительные сведения см. в разделе "Примечания".

[out] CustomReceiveTransaction

Указатель на расположение, в которое этот метод записывает SERCX2CUSTOMRECEIVETRANSACTION дескриптор в только что созданный объект custom-receive-transaction. SerCx2 и драйвер последовательного контроллера используют этот дескриптор в последующих вызовах для ссылки на этот объект.

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

Этот метод возвращает STATUS_SUCCESS, если вызов выполнен успешно. Возможные значения возвращаемых ошибок включают следующие коды состояния.

Возвращаемый код	Описание
STATUS_INVALID_DEVICE_REQUEST	Объект custom-receive-transaction уже существует из предыдущего вызова SerCx2CustomReceiveTransactionCreate.
STATUS_INFO_LENGTH_MISMATCH	Значение CustomReceiveTransactionConfigSize не равно размеру(SERCX2_CUSTOM_RECEIVE_TRANSACTION_CONFIG).
STATUS_INVALID_PARAMETER	Недопустимое значение параметра. Вызывающий объект должен предоставить допустимые EvtSerCx2CustomReceiveTransactionStart и указатели функций EvtSerCx2CustomReceiveTransactionQueryProgress.
STATUS_INSUFFICIENT_RESOURCES	Недостаточно ресурсов для создания объекта custom-receive-transaction.

Замечания

Драйвер последовательного контроллера может вызвать этот метод, чтобы создать объект пользовательской транзакции-получения. SerCx2 использует этот объект для управления транзакциями пользовательского приема, которые являются транзакциями ввода-вывода, использующими пользовательский механизм передачи данных для чтения данных, полученных последовательным контроллером.

В качестве параметра драйвер последовательного контроллера может использовать параметр Атрибуты для создания контекста для объекта пользовательского получения, а также для предоставления указателей на EvtCleanupCallback и EvtDedataCallback функции, которые вызываются для подготовки объекта к удалению. Дополнительные сведения см. в разделе WDF_OBJECT_ATTRIBUTES.

Если параметр атрибутов указывает на структуру WDF_OBJECT_ATTRIBUTES, вызывающий объект не должен перезаписать значения, которые функция инициализации WDF_OBJECT_ATTRIBUTES_INIT записывает в ParentObject, ExecutionLevelи syncScope членов этой структуры.

Если указанное сочетание реализованных функций обратного вызова недопустимо, SerCx2CustomReceiveTransactionCreate вызов завершается ошибкой и возвращает STATUS_INVALID_PARAMETER.

Дополнительные сведения о создании объектов custom-receive-transaction см. в SERCX2CUSTOMRECEIVETRANSACTION. Дополнительные сведения о пользовательских транзакциях получения см. в SerCx2 Custom-Receive транзакций.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Доступно начиная с Windows 8.1.
целевая платформа	Всеобщий
заголовка	sercx.h
IRQL	PASSIVE_LEVEL