Поделиться через


Функция SHGetUnreadMailCountA (shellapi.h)

Извлекает количество непрочитанных сообщений указанного пользователя для всех учетных записей электронной почты.

Синтаксис

HRESULT SHGetUnreadMailCountA(
  [in, optional]  HKEY     hKeyUser,
  [in, optional]  LPCSTR   pszMailAddress,
  [out, optional] DWORD    *pdwCount,
  [out, optional] FILETIME *pFileTime,
  [out, optional] LPSTR    pszShellExecuteCommand,
                  int      cchShellExecuteCommand
);

Параметры

[in, optional] hKeyUser

Тип: HKEY

Допустимый ключ HKEY для данного пользователя. Этот параметр должен иметь значение NULL , если функция вызывается в среде пользователя. В этом случае используется HKEY_CURRENT_USER . Этот параметр должен иметь значение NULL , если функция вызывается из контекста SYSTEM. В этом случае используется HKEY_USERS\{SID} .

[in, optional] pszMailAddress

Тип: LPCTSTR

Указатель на строку в Юникоде, указывающую адрес электронной почты учетной записи, принадлежащей указанному пользователю. Если этот параметр имеет значение NULL, функция pdwCount возвращает общее количество непрочитанных сообщений для всех учетных записей, принадлежащих назначенному пользователю.

[out, optional] pdwCount

Тип: DWORD*

Указатель на значение DWORD, которое получает количество непрочитанных сообщений.

[out, optional] pFileTime

Тип: FILETIME*

Указатель на структуру FILETIME . Использование этого параметра определяется тем, имеет ли pszMailAddressзначение NULL. Если параметр pszMailAddress имеет значение NULL, то этот параметр обрабатывается как параметр [in], который задает фильтр, чтобы отображались только непрочитанные сообщения, превышающие указанное время. Если pszMailAddress не имеет значение NULL, этот параметр обрабатывается как параметр [out], который указывает на структуру FILETIME , в которую функция помещает метку времени последнего вызова SHSetUnreadMailCount для указанного пользователя и учетной записи электронной почты.

[out, optional] pszShellExecuteCommand

Тип: LPCTSTR

Указатель на строку, возвращающую командную инструкцию ShellExecute, переданную в последний вызов SHSetUnreadMailCount для указанного пользователя и учетной записи электронной почты. Эта командная строка запускает почтовое приложение, которому принадлежит учетная запись, на которую ссылается pszMailAddress. Если команда ShellExecute не требуется, этот параметр может иметь значение NULL. Если параметр pszMailAddress имеет значение NULL, этот параметр игнорируется и должен иметь значение NULL.

cchShellExecuteCommand

Тип: int

Максимальный размер (в символах) буфера команд ShellExecute, на который указывает pszShellExecuteCommand. Если параметр pszMailAddress имеет значение NULL, этот параметр должен быть равен нулю. Он также может иметь значение NULL всякий раз, когда командная строка ShellExecute не требуется.

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

Тип: HRESULT

Если эта функция выполняется успешно, она возвращает S_OK. В противном случае возвращается код ошибки HRESULT .

Требования

Требование Значение
Минимальная версия клиента Windows XP [только классические приложения]
Минимальная версия сервера Windows Server 2003 [только классические приложения]
Целевая платформа Windows
Header shellapi.h
Библиотека Shell32.lib
DLL Shell32.dll (версия 6.0 или более поздняя)