Функция GetMailslotInfo (winbase.h)

Статья
08/27/2023

Извлекает сведения об указанном почтовом слое.

Синтаксис

BOOL GetMailslotInfo(
  [in]            HANDLE  hMailslot,
  [out, optional] LPDWORD lpMaxMessageSize,
  [out, optional] LPDWORD lpNextSize,
  [out, optional] LPDWORD lpMessageCount,
  [out, optional] LPDWORD lpReadTimeout
);

Параметры

[in] hMailslot

Дескриптор для почтового объекта. Функция CreateMailslot должна создать этот дескриптор.

[out, optional] lpMaxMessageSize

Максимальный размер сообщения (в байтах), допустимый для этого почтового слоя. Это значение может быть больше или равно значению, указанному в параметре cbMaxMsg функции CreateMailslot , которая создала mailslot. Этот параметр может принимать значение NULL.

[out, optional] lpNextSize

Размер следующего сообщения в байтах. Следующее значение имеет особое значение.

Значение	Значение
MAILSLOT_NO_MESSAGE ((DWORD)-1)	Следующее сообщение отсутствует.

Этот параметр может принимать значение NULL.

[out, optional] lpMessageCount

Общее количество сообщений, ожидающих чтения при возврате функции. Этот параметр может принимать значение NULL.

[out, optional] lpReadTimeout

Время в миллисекундах, в течение которого операция чтения может ожидать, пока сообщение будет записано в mailslot до истечения времени ожидания. Этот параметр заполняется при возврате функции. Этот параметр может принимать значение NULL.

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

Если функция выполняется успешно, возвращается ненулевое значение.

Если функция выполняется неудачно, возвращается нулевое значение. Дополнительные сведения об ошибке можно получить, вызвав GetLastError.

Требования

Требование	Значение
Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	winbase.h (включая Windows.h)
Библиотека	Kernel32.lib
DLL	Kernel32.dll

См. также

CreateMailslot

Функции mailslot

Обзор почтовых слоотов

SetMailslotInfo

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