Fungsi MprConfigTransportGetInfo (mprapi.h)

Artikel
03/15/2023

Fungsi MprConfigTransportGetInfo mengambil konfigurasi untuk protokol transportasi yang ditentukan dari router.

Sintaks

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
);

Parameter

[in] hMprConfig

Tangani ke konfigurasi router. Dapatkan handel ini dengan memanggil MprConfigServerConnect.

[in] hRouterTransport

Tangani ke konfigurasi protokol transportasi yang sedang diambil. Dapatkan handel ini dengan memanggil MprConfigTransportCreate, MprConfigTransportGetHandle, atau MprConfigTransportEnum. Jenis protokol transportasi yang didukung tercantum di Pengidentifikasi Transportasi.

[in, out, optional] ppGlobalInfo

Pada input, arahkan ke variabel penunjuk.

Pada output, variabel pointer ini menunjuk ke header informasi yang berisi informasi global untuk transportasi. Gunakan Fungsi Header Informasi untuk memanipulasi header informasi. Bebaskan buffer ini dengan memanggil MprConfigBufferFree.

Parameter ini bersifat opsional. Jika aplikasi panggilan menentukan NULL untuk parameter ini, fungsi tidak mengambil informasi global.

[out, optional] lpdwGlobalInfoSize

Penunjuk ke variabel DWORD . Variabel ini menerima ukuran, dalam byte, dari buffer yang dikembalikan melalui parameter ppGlobalInfo .

Parameter ini bersifat opsional; aplikasi panggilan dapat menentukan NULL untuk parameter ini. Namun, jika ppGlobalInfo bukan NULL, parameter ini tidak boleh NULL.

[in, out, optional] ppClientInterfaceInfo

Pada input, arahkan ke variabel penunjuk.

Pada output, pointer ini menunjuk ke header informasi yang berisi informasi antarmuka default untuk router klien untuk transportasi ini. Gunakan Fungsi Header Informasi untuk memanipulasi header informasi. Bebaskan buffer dengan memanggil MprConfigBufferFree.

Parameter ini bersifat opsional. Jika aplikasi panggilan menentukan NULL untuk parameter ini, fungsi tidak mengambil informasi antarmuka.

[out, optional] lpdwClientInterfaceInfoSize

Penunjuk ke variabel DWORD . Variabel ini menerima ukuran, dalam byte, dari buffer yang dikembalikan melalui parameter ppClientInterfaceInfo .

Parameter ini bersifat opsional; aplikasi panggilan dapat menentukan NULL untuk parameter ini. Namun, jika ppClientInterfaceInfo bukan NULL, parameter ini tidak boleh NULL.

[in, out, optional] lplpwsDLLPath

Pada input, arahkan ke penunjuk ke string Unicode yang dihentikan null.

Pada output, string Unicode menerima nama DLL manajer router untuk transportasi yang ditentukan.

Parameter ini bersifat opsional. Jika aplikasi panggilan menentukan NULL untuk parameter ini, fungsi tidak mengambil nama DLL manajer router.

Menampilkan nilai

Jika fungsi berhasil, nilai yang dikembalikan adalah NO_ERROR.

Jika fungsi gagal, nilai yang dikembalikan adalah salah satu kode kesalahan berikut.

Nilai	Makna
ERROR_INVALID_PARAMETER	Setidaknya salah satu hal berikut ini benar: hMprConfig adalah NULL hRouterTransport adalah NULL ppGlobalInfo bukan NULL, tetapi lpdwGlobalInfoSize adalah NULL. ppClientInterfaceInfo bukan NULL, tetapi lpdwClientInterfaceInfo adalah NULL.
ERROR_UNKNOWN_PROTOCOL_ID	Konfigurasi protokol transportasi yang sesuai dengan hRouterTransport tidak ditemukan dalam konfigurasi perute.
ERROR_NOT_ENOUGH_MEMORY	Sumber daya tidak cukup untuk menyelesaikan operasi.
Lainnya	Gunakan FormatMessage untuk mengambil pesan kesalahan sistem yang sesuai dengan kode kesalahan yang dikembalikan.

Keterangan

Jika parameter pGlobalInfo, pClientInterfaceInfo, dan lpwsDLLPath semuanya NULL, fungsi tidak melakukan apa pun dan mengembalikan nilai NO_ERROR.

Persyaratan


Klien minimum yang didukung	Tidak ada yang didukung
Server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Target Platform	Windows
Header	mprapi.h
Pustaka	Mprapi.lib
DLL	Mprapi.dll