Função WTSSendMessageW (wtsapi32.h)

Artigo
11/20/2024

Exibe uma caixa de mensagem na área de trabalho do cliente de uma sessão dos Serviços de Área de Trabalho Remota especificada.

Sintaxe

BOOL WTSSendMessageW(
  [in]  HANDLE hServer,
  [in]  DWORD  SessionId,
  [in]  LPWSTR pTitle,
  [in]  DWORD  TitleLength,
  [in]  LPWSTR pMessage,
  [in]  DWORD  MessageLength,
  [in]  DWORD  Style,
  [in]  DWORD  Timeout,
  [out] DWORD  *pResponse,
  [in]  BOOL   bWait
);

Parâmetros

[in] hServer

Um identificador para um servidor host de sessão de área de trabalho remota. Especifique um identificador aberto pela função WTSOpenServer ou especifique WTS_CURRENT_SERVER_HANDLE para indicar o servidor host da sessão rd no qual seu aplicativo está em execução.

[in] SessionId

Um identificador de sessão dos Serviços de Área de Trabalho Remota. Para indicar a sessão atual, especifique WTS_CURRENT_SESSION. Você pode usar a função WTSEnumerateSessions para recuperar os identificadores de todas as sessões em um servidor host de sessão rd especificado.

Para enviar uma mensagem para a sessão de outro usuário, você precisa ter a permissão Mensagem. Para obter mais informações, consulte Serviços de Área de Trabalho Remota
Permissões. Para modificar permissões em uma sessão, use a ferramenta administrativa Configuração de Serviços de Área de Trabalho Remota.

[in] pTitle

Um ponteiro para uma cadeia de caracteres terminada em nulo para a barra de título da caixa de mensagem.

[in] TitleLength

O comprimento, em bytes, da cadeia de caracteres da barra de título.

[in] pMessage

Um ponteiro para uma cadeia de caracteres terminada em nulo que contém a mensagem a ser exibida.

[in] MessageLength

O comprimento, em bytes, da cadeia de caracteres da mensagem.

[in] Style

O conteúdo e o comportamento da caixa de mensagem. Esse valor normalmente é MB_OK. Para obter uma lista completa de valores, consulte o parâmetro uType da função MessageBox.

[in] Timeout

O tempo, em segundos, que a função WTSSendMessage aguarda a resposta do usuário. Se o usuário não responder dentro do intervalo de tempo limite, o parâmetro pResponse retornará IDTIMEOUT. Se o parâmetro Timeout for zero, WTSSendMessage aguardará indefinidamente para que o usuário responda.

[out] pResponse

Um ponteiro para uma variável que recebe a resposta do usuário, que pode ser um dos valores a seguir.

IDABORT (3)

de anulação de

IDCANCEL (2)

cancelar

IDCONTINUE (11)

Continuar

IDIGNORE (5)

Ignorar

IDNO (7)

Sem

IDOK (1)

IDRETRY (4)

de repetição

IDTRYAGAIN (10)

tente novamente

IDYES (6)

Sim

IDASYNC (32001 (0x7D01))

O parâmetro bWait foi FALSE, portanto, a função retornou sem aguardar uma resposta.

IDTIMEOUT (32000 (0x7D00))

O parâmetro bWait foi verdadeiro e o intervalo de tempo limite decorrido.

[in] bWait

Se VERDADEIRO, WTSSendMessage não retornará até que o usuário responda ou o intervalo de tempo limite se esgota. Se o parâmetro Timeout for zero, a função não retornará até que o usuário responda.

Se FALSE, a função retornará imediatamente e o parâmetro pResponse retornará IDASYNC. Use esse método para mensagens de informações simples (como imprimir mensagens de trabalho–notificação) que não precisam retornar a resposta do usuário ao programa de chamada.

Valor de retorno

Se a função for bem-sucedida, o valor retornado será um valor diferente de zero.

Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError.

Observações

Nota

O cabeçalho wtsapi32.h define WTSSendMessage como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows Vista
servidor com suporte mínimo	Windows Server 2008
da Plataforma de Destino	Windows
cabeçalho	wtsapi32.h
biblioteca	Wtsapi32.lib
de DLL	Wtsapi32.dll

Consulte também

messagebox

Compartilhar via