Fungsi SetTcpEntry (iphlpapi.h)
Fungsi SetTcpEntry mengatur status koneksi TCP.
Sintaks
IPHLPAPI_DLL_LINKAGE DWORD SetTcpEntry(
[in] PMIB_TCPROW pTcpRow
);
Parameter
[in] pTcpRow
Penunjuk ke struktur MIB_TCPROW . Struktur ini menentukan informasi untuk mengidentifikasi koneksi TCP yang akan dimodifikasi. Ini juga menentukan status baru untuk koneksi TCP. Penelepon harus menentukan nilai untuk semua anggota dalam struktur ini.
Nilai kembali
Fungsi mengembalikan NO_ERROR (nol) jika fungsi berhasil.
Jika fungsi gagal, nilai yang dikembalikan adalah salah satu kode kesalahan berikut.
| Mengembalikan kode/nilai | Deskripsi |
|---|---|
|
Akses ditolak. Kesalahan ini dikembalikan pada Windows Vista dan Windows Server 2008 dalam beberapa kondisi yang mencakup hal berikut: pengguna tidak memiliki hak administratif yang diperlukan di komputer lokal atau aplikasi tidak berjalan dalam shell yang ditingkatkan sebagai Administrator bawaan (administrator RunAs). |
|
Parameter input tidak valid, tidak ada tindakan yang diambil. Kesalahan ini dikembalikan jika parameter pTcpRow adalah NULL atau anggota Baris dalam struktur MIB_TCPROW yang ditunjukkan oleh parameter pTcpRow tidak diatur ke MIB_TCP_STATE_DELETE_TCB. |
|
Transportasi IPv4 tidak dikonfigurasi pada komputer lokal. |
|
Fungsi ini tidak dapat mengatur entri TCP karena aplikasi berjalan tidak ditingkatkan. |
|
Gunakan FormatMessage untuk mendapatkan string pesan untuk kesalahan yang dikembalikan. |
Keterangan
Saat ini, satu-satunya status yang dapat diatur oleh koneksi TCP adalah MIB_TCP_STATE_DELETE_TCB.
Pada Windows Vista dan yang lebih baru, fungsi SetTcpEntry hanya dapat dipanggil oleh pengguna yang masuk sebagai anggota grup Administrator. Jika SetTcpEntry dipanggil oleh pengguna yang bukan anggota grup Administrator, panggilan fungsi akan gagal dan ERROR_ACCESS_DENIED dikembalikan.
Fungsi SetTcpEntry juga dapat gagal karena kontrol akun pengguna (UAC) pada Windows Vista dan yang lebih baru. Jika aplikasi yang berisi fungsi ini dijalankan oleh pengguna yang masuk sebagai anggota grup Administrator selain Administrator bawaan, panggilan ini akan gagal kecuali aplikasi telah ditandai dalam file manifes dengan requestedExecutionLevel yang diatur ke requireAdministrator. Jika aplikasi tidak memiliki file manifes ini, pengguna yang masuk sebagai anggota grup Administrator selain Administrator bawaan kemudian harus menjalankan aplikasi dalam shell yang ditingkatkan sebagai Administrator bawaan (administrator RunAs) agar fungsi ini berhasil.
Persyaratan
| Persyaratan | Nilai |
|---|---|
| Klien minimum yang didukung | Windows 2000 Professional [hanya aplikasi desktop] |
| Server minimum yang didukung | Windows 2000 Server [hanya aplikasi desktop] |
| Target Platform | Windows |
| Header | iphlpapi.h |
| Pustaka | Iphlpapi.lib |
| DLL | Iphlpapi.dll |