Fungsi WSAAsyncGetHostByName (winsock.h)
Fungsi WSAAsyncGetHostByName secara asinkron mengambil informasi host yang sesuai dengan nama host.
Sintaks
HANDLE WSAAsyncGetHostByName(
HWND hWnd,
u_int wMsg,
const char *name,
char *buf,
int buflen
);
Parameter
hWnd
TBD
wMsg
TBD
name
TBD
buf
TBD
buflen
TBD
Nilai kembali
Nilai yang dikembalikan menentukan apakah operasi asinkron berhasil dimulai atau tidak. Ini tidak menyiratkan keberhasilan atau kegagalan operasi itu sendiri.
Jika tidak ada kesalahan yang terjadi, WSAAsyncGetHostByName mengembalikan nilai bukan nol dari jenis HANDLE yang merupakan handel tugas asinkron (tidak bingung dengan HTASK Windows) untuk permintaan tersebut. Nilai ini dapat digunakan dengan dua cara. Ini dapat digunakan untuk membatalkan operasi menggunakan WSACancelAsyncRequest, atau dapat digunakan untuk mencocokkan operasi asinkron dan pesan penyelesaian dengan memeriksa parameter pesan wParam .
Jika operasi asinkron tidak dapat dimulai, WSAAsyncGetHostByName mengembalikan nilai nol, dan nomor kesalahan tertentu dapat diambil dengan memanggil WSAGetLastError.
Kode kesalahan berikut dapat diatur saat jendela aplikasi menerima pesan. Seperti yang dijelaskan di atas, mereka dapat diekstrak dari lParam dalam pesan balasan menggunakan makro WSAGETASYNCERROR.
Kode kesalahan | Makna |
---|---|
Subsistem jaringan gagal. | |
Ruang buffer tidak cukup tersedia. | |
Parameter nama atau buf tidak berada di bagian ruang alamat proses yang valid. | |
Host jawaban otoritatif tidak ditemukan. | |
Host nonauthoritative tidak ditemukan, atau SERVERFAIL. | |
Kesalahan yang tidak dapat dipulihkan: FORMERR, REFUSED, NOTIMP. | |
Nama yang valid, tidak ada catatan data dari jenis yang diminta. |
Kesalahan berikut dapat terjadi pada saat panggilan fungsi, dan menunjukkan bahwa operasi asinkron tidak dapat dimulai.
Kode kesalahan | Makna |
---|---|
WSANOTINITIALISED | Panggilan WSAStartup yang berhasil harus terjadi sebelum menggunakan fungsi ini. |
WSAENETDOWN | Subsistem jaringan gagal. |
WSAEINPROGRESS | Pemblokiran panggilan Windows Sockets 1.1 sedang berlangsung, atau penyedia layanan masih memproses fungsi panggilan balik. |
WSAEWOULDBLOCK | Operasi asinkron tidak dapat dijadwalkan saat ini karena sumber daya atau batasan lain dalam implementasi Windows Sockets. |
Keterangan
Fungsi WSAAsyncGetHostByName adalah versi asinkron dari gethostbyname, dan digunakan untuk mengambil nama host dan informasi alamat yang sesuai dengan nama host. Windows Sockets memulai operasi dan segera kembali ke pemanggil, meneruskan kembali handel tugas asinkron buram yang dapat digunakan aplikasi untuk mengidentifikasi operasi. Ketika operasi selesai, hasilnya (jika ada) disalin ke dalam buffer yang disediakan oleh pemanggil dan pesan dikirim ke jendela aplikasi.
Ketika operasi asinkron telah selesai, jendela aplikasi yang ditunjukkan oleh parameter hWnd menerima pesan dalam parameter wMsg . Parameter wParam berisi handel tugas asinkron seperti yang dikembalikan oleh panggilan fungsi asli. LParam 16 bit tinggi berisi kode kesalahan apa pun. Kode kesalahan dapat berupa kesalahan apa pun seperti yang didefinisikan dalam Winsock2.h. Kode kesalahan nol menunjukkan keberhasilan penyelesaian operasi asinkron.
Setelah berhasil diselesaikan, buffer yang ditentukan ke panggilan fungsi asli berisi struktur hostent . Untuk mengakses elemen struktur ini, alamat buffer asli harus ditransmisikan ke penunjuk struktur hosten dan diakses sebagaimana mestinya.
Jika kode kesalahan adalah WSAENOBUFS, ukuran buffer yang ditentukan oleh buflen dalam panggilan asli terlalu kecil untuk berisi semua informasi yang dihasilkan. Dalam hal ini, lParam 16 bit rendah berisi ukuran buffer yang diperlukan untuk menyediakan semua informasi yang diperlukan. Jika aplikasi memutuskan bahwa data parsial tidak memadai, aplikasi dapat mengeluarkan kembali panggilan fungsi WSAAsyncGetHostByName dengan buffer yang cukup besar untuk menerima semua informasi yang diinginkan (yaitu, tidak lebih kecil dari 16 bit lParam yang rendah).
Buffer yang ditentukan untuk fungsi ini digunakan oleh Windows Sockets untuk membangun struktur hostent bersama dengan konten area data yang dirujuk oleh anggota struktur hosten yang sama. Untuk menghindari kesalahan WSAENOBUFS , aplikasi harus menyediakan buffer setidaknya byte MAXGETHOSTSTRUCT (seperti yang didefinisikan dalam Winsock2.h).
Kode kesalahan dan panjang buffer harus diekstrak dari lParam menggunakan makro WSAGETASYNCERROR dan WSAGETASYNCBUFLEN, didefinisikan dalam Winsock2.h sebagai:
#include <windows.h>
#define WSAGETASYNCBUFLEN(lParam) LOWORD(lParam)
#define WSAGETASYNCERROR(lParam) HIWORD(lParam)
Penggunaan makro ini akan memaksimalkan portabilitas kode sumber untuk aplikasi.
WSAAsyncGetHostByName dijamin untuk menyelesaikan string yang dikembalikan oleh panggilan yang berhasil ke gethostname.
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 | winsock.h (termasuk Winsock2.h, Winsock.h) |
Pustaka | Ws2_32.lib |
DLL | Ws2_32.dll |