Fungsi MprConfigInterfaceTransportGetInfo (mprapi.h)

Artikel
03/15/2023

Fungsi MprConfigInterfaceTransportGetInfo mengambil informasi konfigurasi untuk klien yang ditentukan pada antarmuka yang ditentukan.

Sintaks

DWORD MprConfigInterfaceTransportGetInfo(
  [in]                HANDLE  hMprConfig,
  [in]                HANDLE  hRouterInterface,
  [in]                HANDLE  hRouterIfTransport,
  [in, out, optional] LPBYTE  *ppInterfaceInfo,
  [out, optional]     LPDWORD lpdwInterfaceInfoSize
);

Parameter

[in] hMprConfig

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

[in] hRouterInterface

Tangani ke konfigurasi antarmuka untuk mengambil informasi klien yang ditentukan. Dapatkan handel ini dengan memanggil MprConfigInterfaceCreate, MprConfigInterfaceGetHandle, atau MprConfigInterfaceEnum.

[in] hRouterIfTransport

Tangani ke konfigurasi transportasi untuk mengambil informasi klien yang ditentukan. Dapatkan handel ini dengan memanggil MprConfigInterfaceTransportAdd, MprConfigInterfaceTransportGetHandle, atau MprConfigInterfaceTransportEnum. Jenis protokol transportasi yang didukung tercantum di Pengidentifikasi Transportasi.

[in, out, optional] ppInterfaceInfo

Pada input, arahkan ke variabel penunjuk.

Pada output, variabel pointer ini menunjuk ke header informasi yang berisi informasi konfigurasi untuk klien. Gunakan Fungsi Header Informasi untuk memanipulasi header informasi. Bebaskan memori ini dengan memanggil MprConfigBufferFree.

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

[out, optional] lpdwInterfaceInfoSize

Penunjuk ke variabel DWORD . Variabel ini menerima ukuran, dalam byte, dari data yang ditujukan oleh ppInterfaceInfo.

Parameter ini bersifat opsional; aplikasi panggilan dapat menentukan NULL untuk parameter ini. Namun, jika ppInterfaceInfo bukan NULL, parameter ini tidak boleh NULL. Untuk informasi selengkapnya, lihat bagian Keterangan nanti dalam topik ini.

Menampilkan nilai

Jika fungsi berhasil, nilai yang dikembalikan adalah NO_ERROR. Untuk informasi selengkapnya, lihat bagian Keterangan nanti dalam topik ini.

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

Nilai	Makna
ERROR_INVALID_PARAMETER	Salah satu hal berikut ini benar: hMprConfig adalah NULL. hRouterInterface adalah NULL. hRouterIfTransport adalah NULL. ppInterfaceInfo bukan NULL, tetapi lpdwInterfaceInfoSize adalah NULL.
ERROR_NO_SUCH_INTERFACE	Antarmuka yang ditentukan oleh hRouterIfTransport tidak ditemukan dalam konfigurasi perute, atau transportasi yang ditentukan oleh hRouterIfTransport tidak diaktifkan pada antarmuka yang ditentukan.
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 ppInterfaceInfo adalah NULL, MprConfigInterfaceTransportGetInfo tidak melakukan apa pun dan segera mengembalikan dengan 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