Função RtmGetChangedDests (rtmv2.h)

Artigo
03/13/2024

A função RtmGetChangedDests retorna um conjunto de destinos com informações alteradas.

Sintaxe

DWORD RtmGetChangedDests(
  [in]      RTM_ENTITY_HANDLE RtmRegHandle,
  [in]      RTM_NOTIFY_HANDLE NotifyHandle,
  [in, out] PUINT             NumDests,
  [out]     PRTM_DEST_INFO    ChangedDests
);

Parâmetros

[in] RtmRegHandle

Manipule para o cliente obtido de uma chamada anterior para RtmRegisterEntity.

[in] NotifyHandle

Manipule para uma notificação de alteração obtida de uma chamada anterior para RtmRegisterForChangeNotification.

[in, out] NumDests

Na entrada, NumDests é um ponteiro para um valor UINT que especifica o número máximo de destinos que podem ser recebidos por ChangedDests.

Na saída, NumDests recebe o número real de destinos recebidos por ChangedDests.

[out] ChangedDests

Na entrada, ChangedDests é um ponteiro para uma matriz de estruturas de RTM_DEST_INFO .

Na saída, ChangedDests é preenchido com as informações de destino alteradas.

Retornar valor

Se a função for bem-sucedida, o valor retornado será NO_ERROR.

Se a função falhar, o valor retornado será um dos seguintes códigos de erro.

Valor	Significado
ERROR_INVALID_PARAMETER	Um parâmetro contém informações incorretas.
ERROR_NO_MORE_ITEMS	Não há mais destinos alterados para recuperar.

Comentários

Um cliente é notificado sobre alterações por um RTM_EVENT_CALLBACK. O RTM_EVENT_CALLBACK é usado apenas para notificar o cliente e não entregar as alterações. Depois que uma notificação de alteração é recebida, o cliente deve chamar RtmGetChangedDests repetidamente para recuperar todas as alterações.

Se duas ou mais alterações no mesmo destino tiverem ocorrido desde a notificação, somente a alteração mais recente será retornada.

Quando um cliente não precisa mais dos identificadores em ChangedDests, o cliente deve usar RtmReleaseChangedDests para liberar os identificadores.

Para obter o código de exemplo que usa essa função, consulte Usar o retorno de chamada de notificação de evento.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Nenhum compatível
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	rtmv2.h
Biblioteca	Rtm.lib
DLL	Rtm.dll