平台 SDK: 进程通信

GetMailslotInfo

GetMailslotInfo函数检索有关指定邮槽的信息。

BOOL GetMailslotInfo(
  HANDLE hMailslot,          // 邮槽句柄
  LPDWORD lpMaxMessageSize,  // 最大消息大小
  LPDWORD lpNextSize,        // 下一条消息的大小
  LPDWORD lpMessageCount,    // 消息的数量
  LPDWORD lpReadTimeout      // 读超时间隔
);

参数

  • hMailslot

  • [in] 邮槽句柄。 CreateMailslot函数必须创建这个句柄。

  • lpMaxMessageSize

  • [in] 当函数返回时,指向缓冲区的指针允许此邮槽允许的最大邮件大小(以字节为单位)。 该值可以大于或等于创建邮筒的CreateMailslot函数的cbMaxMsg参数中指定的值。 该参数可以是NULL。

  • lpNextSize

  • [in] 指向缓冲区的指针,指定函数返回时下一条消息的大小(以字节为单位)。 以下值具有特殊含义。

    含义
    MAILSLOT_NO_MESSAGE没有下一条消息。


    该参数可以是NULL。

  • lpMessageCount

  • [in] 指向缓冲区的指针指定等待读取的消息总数,当函数返回时。 该参数可以是NULL。

  • lpReadTimeout

  • [in] 指向指定时间量(以毫秒为单位)的读取操作的缓冲区的指针可以等待消息在发生超时之前写入邮筒。 该函数返回时填入此参数。 该参数可以是NULL。

返回值

如果函数成功,返回值为非零。

如果函数失败,返回值为零。 要获得扩展的错误信息,请调用GetLastError。

示例代码

有关示例,请参阅从邮槽阅读。

要求

  Windows NT/2000/XP: 包含在Windows NT 3.51和更高版本中。

  Windows 95/98/Me: 包含在Windows 95和更高版本中。

  头文件: 声明于 Winbase.h; 包含于  Windows.h.
  库: 使用 Kernel32.lib.