Função SHGetUnreadMailCountW (shellapi.h)

Artigo
08/26/2023

Recupera a contagem de mensagens não lidas de um usuário especificado para qualquer ou todas as contas de email.

Sintaxe

HRESULT SHGetUnreadMailCountW(
  [in, optional]  HKEY     hKeyUser,
  [in, optional]  LPCWSTR  pszMailAddress,
  [out, optional] DWORD    *pdwCount,
  [out, optional] FILETIME *pFileTime,
  [out, optional] LPWSTR   pszShellExecuteCommand,
                  int      cchShellExecuteCommand
);

Parâmetros

[in, optional] hKeyUser

Tipo: HKEY

Um HKEY válido para um determinado usuário. Esse parâmetro deverá ser NULL se a função for chamada no ambiente de um usuário; nesse caso , HKEY_CURRENT_USER é usado. Esse parâmetro deverá ser NULL se a função for chamada do contexto SYSTEM, nesse caso , HKEY_USERS\{SID} for usado.

[in, optional] pszMailAddress

Tipo: LPCTSTR

Um ponteiro para uma cadeia de caracteres em Unicode que especifica o endereço de email de uma conta que pertence ao usuário especificado. Quando esse parâmetro é NULL, pdwCount retorna a contagem total de mensagens não lidas para todas as contas pertencentes ao usuário designado.

[out, optional] pdwCount

Tipo: DWORD*

Ponteiro para um valor DWORD que recebe a contagem de mensagens não lidas.

[out, optional] pFileTime

Tipo: FILETIME*

Um ponteiro para uma estrutura FILETIME . O uso desse parâmetro é determinado por se pszMailAddress é NULL. Se pszMailAddress for NULL, esse parâmetro será tratado como um parâmetro [in], que especifica um filtro, de modo que apenas emails não lidos mais recentes que a hora especificada sejam exibidos. Se pszMailAddress não for NULL, esse parâmetro será tratado como um parâmetro [out], que aponta para uma estrutura FILETIME na qual a função coloca o carimbo de data/hora da última chamada SHSetUnreadMailCount para o usuário e a conta de email especificados.

[out, optional] pszShellExecuteCommand

Tipo: LPCTSTR

Um ponteiro para uma cadeia de caracteres que retorna a instrução de comando ShellExecute passada para a última chamada SHSetUnreadMailCount para o usuário e a conta de email especificados. Essa cadeia de caracteres de comando inicia o aplicativo de email que possui a conta referenciada por pszMailAddress. Se o comando ShellExecute não for necessário, esse parâmetro poderá ser NULL. Se pszMailAddress for NULL, esse parâmetro será ignorado e deverá ser NULL.

cchShellExecuteCommand

Tipo: int

O tamanho máximo, em caracteres, do buffer de comando ShellExecute apontado por pszShellExecuteCommand. Esse parâmetro deve ser zero para contagens totais quando pszMailAddress é NULL. Ele também pode ser NULL sempre que a cadeia de caracteres de comando ShellExecute não for necessária.

Retornar valor

Tipo: HRESULT

Se essa função for bem-sucedida, ela retornará S_OK. Caso contrário, ele retornará um código de erro HRESULT.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows XP [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	shellapi.h
Biblioteca	Shell32.lib
DLL	Shell32.dll (versão 6.0 ou posterior)