MprAdminTransportGetInfo 函式 (mprapi.h)

  • 發行項

MprAdminTransportGetInfo 函式會擷取指定傳輸的全域資訊、默認用戶端介面資訊或兩者。

語法

DWORD MprAdminTransportGetInfo(
  [in]            MPR_SERVER_HANDLE hMprServer,
  [in]            DWORD             dwTransportId,
  [out, optional] LPBYTE            *ppGlobalInfo,
  [out, optional] LPDWORD           lpdwGlobalInfoSize,
  [out, optional] LPBYTE            *ppClientInterfaceInfo,
  [out, optional] LPDWORD           lpdwClientInterfaceInfoSize
);

參數

[in] hMprServer

處理要從中擷取資訊的路由器。 這個句柄是從先前呼叫 MprAdminServerConnect 取得。

[in] dwTransportId

描述要擷取之傳輸類型的 DWORD 值。 下表列出 dwTransportId 可接受的值。

值 傳輸 (通訊協定系列)
PID_ATALK AppleTalk
PID_IP 因特網通訊協定第 4 版
PID_IPX 因特網封包交換
PID_NBF NetBIOS 框架通訊協定
PID_IPV6 Windows Server 2008 或更新版本：因特網通訊協定第 6 版

[out, optional] ppGlobalInfo

指標變數的指標。 此變數指向接收此傳輸之全域資訊的信息標頭。 使用 資訊標頭函式 來管理信息標頭。

藉由呼叫 MprAdminBufferFree 來釋放此記憶體。

這是選擇性參數。 如果呼叫的應用程式指定此參數的 NULL ，則函式不會擷取全域資訊。

[out, optional] lpdwGlobalInfoSize

DWORD 變數的指標。 此變數會接收傳輸之全域資訊的大小，以位元組為單位。

[out, optional] ppClientInterfaceInfo

指標變數的指標。 此變數會指向此傳輸的預設用戶端介面資訊。 藉由呼叫 MprAdminBufferFree 來釋放此記憶體。

這是選擇性參數。 如果呼叫的應用程式指定此參數的 NULL ，則函式不會擷取用戶端介面資訊。

[out, optional] lpdwClientInterfaceInfoSize

DWORD 變數的指標。 此變數會接收用戶端介面資訊的大小，以位元組為單位。

傳回值

如果函式成功，傳回值會NO_ERROR。

如果函式失敗，傳回值就是下列其中一個錯誤碼。

值 意義
ERROR_ACCESS_DENIED
 呼叫的應用程式沒有足夠的許可權。
ERROR_INVALID_PARAMETER
 以下其中一項為正確：
  • ppGlobalInfo 參數和 ppClientInterfaceInfo 參數都是 NULL。
  • ppGlobalInfo 參數不會指向有效的記憶體。
  • ppClientInterfaceInfo 參數不會指向有效的記憶體。
ERROR_NOT_ENOUGH_MEMORY
 資源不足，無法完成作業。
ERROR_UNKNOWN_PROTOCOL_ID
 dwTransportId 值不符合任何已安裝的傳輸。

備註

ppGlobalInfo 和 ppClientInterfaceInfo 參數不可以是 NULL。

規格需求

需求 值
最低支援的用戶端 都不支援
最低支援的伺服器 Windows 2000 Server [僅限傳統型應用程式]
目標平台 Windows
標頭 mprapi.h
程式庫 Mprapi.lib
Dll Mprapi.dll

另請參閱

MprAdminBufferFree

MprAdminServerConnect

MprAdminTransportSetInfo

路由器管理功能

路由器管理參考