MprConfigTransportGetInfo 函数 (mprapi.h)

项目
08/24/2023

MprConfigTransportGetInfo 函数从路由器检索指定传输协议的配置。

语法

DWORD MprConfigTransportGetInfo(
  [in]                HANDLE  hMprConfig,
  [in]                HANDLE  hRouterTransport,
  [in, out, optional] LPBYTE  *ppGlobalInfo,
  [out, optional]     LPDWORD lpdwGlobalInfoSize,
  [in, out, optional] LPBYTE  *ppClientInterfaceInfo,
  [out, optional]     LPDWORD lpdwClientInterfaceInfoSize,
  [in, out, optional] LPWSTR  *lplpwsDLLPath
);

parameters

[in] hMprConfig

路由器配置的句柄。通过调用 MprConfigServerConnect 获取此句柄。

[in] hRouterTransport

正在检索的传输协议配置的句柄。通过调用 MprConfigTransportCreate、 MprConfigTransportGetHandle 或 MprConfigTransportEnum 获取此句柄。支持的传输协议类型列在传输标识符上。

[in, out, optional] ppGlobalInfo

输入时，指针指向指针变量。

在输出时，此指针变量指向包含传输全局信息的信息标头。使用信息标头函数操作信息标头。通过调用 MprConfigBufferFree 释放此缓冲区。

此参数是可选的。如果调用应用程序为此参数指定 NULL ，则该函数不会检索全局信息。

[out, optional] lpdwGlobalInfoSize

指向 DWORD 变量的指针。此变量接收通过 ppGlobalInfo 参数返回的缓冲区的大小（以字节为单位）。

此参数是可选的;调用应用程序可以为此参数指定 NULL 。但是，如果 ppGlobalInfo 不是 NULL，则此参数不能为 NULL。

[in, out, optional] ppClientInterfaceInfo

输入时，指针指向指针变量。

在输出时，此指针指向包含此传输客户端路由器的默认接口信息的信息标头。使用信息标头函数操作信息标头。通过调用 MprConfigBufferFree 释放缓冲区。

此参数是可选的。如果调用应用程序为此参数指定 NULL ，则该函数不会检索接口信息。

[out, optional] lpdwClientInterfaceInfoSize

指向 DWORD 变量的指针。此变量接收通过 ppClientInterfaceInfo 参数返回的缓冲区的大小（以字节为单位）。

此参数是可选的;调用应用程序可以为此参数指定 NULL 。但是，如果 ppClientInterfaceInfo 不是 NULL，则此参数不能为 NULL。

[in, out, optional] lplpwsDLLPath

输入时，指针指向指向 以 null 结尾的 Unicode 字符串的指针。

输出时，Unicode 字符串接收指定传输的路由器管理器 DLL 的名称。

此参数是可选的。如果调用应用程序为此参数指定 NULL ，则该函数不会检索路由器管理器 DLL 的名称。

返回值

如果函数成功，则返回值NO_ERROR。

如果函数失败，则返回值为以下错误代码之一。

值	含义
ERROR_INVALID_PARAMETER	以下至少一个条件成立： hMprConfig 为 NULL hRouterTransport 为 NULL ppGlobalInfo 不是 NULL，但 lpdwGlobalInfoSize 为 NULL。 ppClientInterfaceInfo 不是 NULL，但 lpdwClientInterfaceInfo 为 NULL。
ERROR_UNKNOWN_PROTOCOL_ID	路由器配置中找不到对应于 hRouterTransport 的传输协议配置。
ERROR_NOT_ENOUGH_MEMORY	资源不足，无法完成操作。
其他	使用 FormatMessage 检索与返回的错误代码对应的系统错误消息。

注解

如果 pGlobalInfo、 pClientInterfaceInfo 和 lpwsDLLPath 参数均为 NULL，则该函数不执行任何操作，并返回值 NO_ERROR。

要求


最低受支持的客户端	无受支持的版本
最低受支持的服务器	Windows 2000 Server [仅限桌面应用]
目标平台	Windows
标头	mprapi.h
Library	Mprapi.lib
DLL	Mprapi.dll