IO_SESSION_NOTIFICATION_FUNCTION função de retorno de chamada (wdm.h)
O tipo de função IO_SESSION_NOTIFICATION_FUNCTION define uma rotina de retorno de chamada por meio da qual um driver recebe notificações de alterações no estado das sessões de usuário nas quais o driver está interessado.
Sintaxe
IO_SESSION_NOTIFICATION_FUNCTION IoSessionNotificationFunction;
NTSTATUS IoSessionNotificationFunction(
[in] PVOID SessionObject,
[in] PVOID IoObject,
[in] ULONG Event,
[in] PVOID Context,
[in] PVOID NotificationPayload,
[in] ULONG PayloadLength
)
{...}
Parâmetros
[in] SessionObject
Ponteiro para um objeto opaco do sistema que contém informações sobre a sessão do usuário. O driver pode passar esse valor de ponteiro para a rotina de IoGetContainerInformation como o valor do parâmetro ContainerObject.
[in] IoObject
Ponteiro para um objeto de E/S de propriedade do driver. Esse parâmetro é o ponteiro de objeto de E/S que o driver forneceu à rotina de IoRegisterContainerNotification do quando o driver se registrou anteriormente para receber notificações de eventos de sessão. O parâmetro IoRegisterContainerNotificationNotificationInformation aponta para uma estrutura de IO_SESSION_STATE_NOTIFICATION cujo membro IoObject aponta para o objeto de E/S.
[in] Event
Uma constante de enumeração IO_SESSION_EVENT que indica qual evento de sessão causou o retorno de chamada de notificação.
[in] Context
O valor de contexto que o driver forneceu anteriormente à rotina IoRegisterContainerNotification quando o driver se registrou para receber notificações de eventos de sessão. Na chamada IoRegisterContainerNotification, o driver forneceu um ponteiro para uma estrutura IO_SESSION_STATE_NOTIFICATION cujo membro Context contém o valor de contexto.
[in] NotificationPayload
Ponteiro para um buffer de carga que contém uma estrutura IO_SESSION_CONNECT_INFO.
[in] PayloadLength
O tamanho, em bytes, do buffer apontado por notificationPayload. O tamanho do buffer nunca precisa exceder o valor constante IO_SESSION_MAX_PAYLOAD_SIZE, que é definido no arquivo de cabeçalho Wdm.h.
Valor de retorno
Se a rotina for bem-sucedida, ela deverá retornar STATUS_SUCCESS. Caso contrário, ele deverá retornar um dos valores de status de erro definidos no arquivo de cabeçalho Ntstatus.h.
Observações
Um driver no modo kernel implementa essa rotina. O gerente de E/S chama essa rotina para notificar o driver de eventos de sessão.
Para receber notificações de eventos de sessão, um driver chama a rotina IoRegisterContainerNotification e define o parâmetro CallbackFunction dessa rotina para apontar para a rotina de IO_SESSION_NOTIFICATION_FUNCTION do driver. O objeto de E/S que o driver passa para IoRegisterContainerNotification determina se o driver receberá notificações de eventos em uma sessão de usuário específica ou de eventos em todas as sessões. Para obter mais informações, consulte IO_SESSION_STATE_NOTIFICATION.
Exemplos
Para definir uma rotina de notificação de sessão de E/S, primeiro você deve fornecer uma declaração de função que identifique o tipo de rotina de retorno de chamada que você está definindo. O Windows fornece um conjunto de tipos de função de retorno de chamada para drivers. Declarar uma função usando os tipos de função de retorno de chamada ajuda a análise de código para drivers, SDV (Verificador de Driver Estático) e outras ferramentas de verificação encontram erros e é um requisito para gravar drivers para o sistema operacional Windows.
Por exemplo, para definir uma rotina de notificação de sessão de E/S denominada MyIoSessionNotification, use o tipo IO_SESSION_NOTIFICATION_FUNCTION, conforme mostrado neste exemplo de código:
IO_SESSION_NOTIFICATION_FUNCTION MyIoSessionNotification;
Em seguida, implemente sua rotina de retorno de chamada da seguinte maneira:
_Use_decl_annotations_
NTSTATUS
MyIoSessionNotification(
PVOID SessionObject,
PVOID IoObject,
ULONG Event,
PVOID Context,
PVOID NotificationPayload,
ULONG PayloadLength
)
{
// Function body
}
O tipo de função IO_SESSION_NOTIFICATION_FUNCTION é definido no arquivo de cabeçalho Wdm.h. Para identificar erros com mais precisão ao executar as ferramentas de análise de código, adicione a anotação _Use_decl_annotations_ à sua definição de função. A anotação _Use_decl_annotations_ garante que as anotações aplicadas ao tipo de função IO_SESSION_NOTIFICATION_FUNCTION no arquivo de cabeçalho sejam usadas. Para obter mais informações sobre os requisitos para declarações de função, consulte Declarando funções usando tipos de função de função para drivers WDM. Para obter informações sobre _Use_decl_annotations_, consulte Anotando o comportamento da função.
Requisitos
| Requisito | Valor |
|---|---|
| de cliente com suporte mínimo | Com suporte no Windows 7 e versões posteriores do sistema operacional Windows. |
| da Plataforma de Destino | Área de trabalho |
| cabeçalho | wdm.h (include Wdm.h, Ntddk.h, Ntifs.h, Fltkernel.h) |
| IRQL | Chamado no <DO IRQL = APC_LEVEL. |