LPNSPV2CLEANUP fungsi panggilan balik (ws2spi.h)

Artikel
03/15/2023

Fungsi NSPv2Cleanup memberi tahu penyedia layanan namespace layanan versi-2 (NSPv2) bahwa sesi klien telah dihentikan.

Sintaks

LPNSPV2CLEANUP Lpnspv2cleanup;

INT Lpnspv2cleanup(
  [in] LPGUID lpProviderId,
  [in] LPVOID pvClientSessionArg
)
{...}

Parameter

[in] lpProviderId

Penunjuk ke GUID penyedia namespace yang akan diberi tahu.

[in] pvClientSessionArg

Penunjuk ke sesi klien.

Mengembalikan nilai

Fungsi harus mengembalikan NO_ERROR (nol) jika rutinitas berhasil. Ini harus mengembalikan SOCKET_ERROR (yaitu, 1) jika rutinitas gagal dan harus mengatur kode kesalahan yang sesuai menggunakan WSASetLastError.

Kode kesalahan	Makna
WSA_NOT_ENOUGH_MEMORY	Tidak tersedia cukup memori untuk melakukan operasi ini.
WSAEACCES	Rutinitas panggilan tidak memiliki hak istimewa yang memadai untuk menginisialisasi layanan.
WSAEINVAL	Satu atau beberapa parameter tidak valid, atau hilang, untuk penyedia ini.
WSAEOPNOTSUPP	Operasi ini tidak didukung. Kesalahan ini dikembalikan jika penyedia namespace tidak mengimplementasikan fungsi ini.
WSASERVICE_NOT_FOUND	Layanan tidak diketahui. Layanan tidak dapat ditemukan di namespace yang ditentukan.

Keterangan

Fungsi NSPv2Cleanup digunakan sebagai bagian dari arsitektur penyedia layanan namespace layanan versi-2 (NSPv2) yang tersedia di Windows Vista dan yang lebih baru.

Pada Windows Vista dan Windows Server 2008, fungsi NSPv2Cleanup hanya dapat digunakan untuk operasi pada penyedia namespace NS_EMAIL.

Fungsi NSPv2Startup dipanggil setiap kali proses klien baru dimulai menggunakan penyedia namespace layanan. Penyedia dapat menggunakan argumen sesi klien yang diarahkan oleh parameter ppvClientSessionArg untuk menyimpan informasi tentang sesi ini. Jika nilai ditentukan untuk argumen sesi klien dalam panggilan ke fungsi NSPv2Startup , argumen sesi klien yang sama ini dapat diteruskan dalam parameter pvClientSessionArg ke fungsi NSPv2Cleanup untuk memberi tahu penyedia namespace layanan bahwa sesi klien telah dihentikan.

Fungsi NSPv2Cleanup dipanggil ketika aplikasi selesai menggunakan penyedia layanan namespace Layanan Soket Windows. NSPv2Cleanup memungkinkan penyedia namespace untuk membebaskan salah satu sumber daya penyedia namespace yang dialokasikan untuk sesi klien.

Fungsi NSPv2Startup harus berhasil dipanggil sebelum memanggil fungsi NSPv2Cleanup . Diperbolehkan untuk melakukan lebih dari satu panggilan NSPv2Startup . Namun, untuk setiap panggilan NSPv2Startup , panggilan NSPv2Cleanup yang sesuai juga harus dikeluarkan. Hanya NSPv2Cleanup akhir untuk penyedia layanan yang melakukan pembersihan aktual; panggilan sebelumnya mengurangi jumlah referensi internal di penyedia layanan.

Fungsi NSPv2Startup, NSPv2ClientSessionRundown, dan NSPv2Cleanup bersifat opsional, tergantung pada persyaratan penyedia NSPv2.

Jika fungsi NSPv2Cleanup tidak diimplementasikan, maka panggilan ke fungsi tersebut harus disadap oleh fungsi stub yang mengembalikan WSAEOPNOTSUPP. Penunjuk fungsi NSPv2 ke fungsi NSPv2Cleanup yang tidak dibedakan dalam struktur NSPV2_ROUTINE harus menunjuk ke fungsi stub.

Persyaratan


Klien minimum yang didukung	Windows Vista [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2008 [hanya aplikasi desktop]
Target Platform	Windows
Header	ws2spi.h