Fungsi NPFormatNetworkName (npapi.h)

Memformat nama jaringan dalam format khusus penyedia untuk ditampilkan dalam kontrol.

Syntax

DWORD NPFormatNetworkName(
  [in]      LPWSTR  lpRemoteName,
  [out]     LPWSTR  lpFormattedName,
  [in, out] LPDWORD lpnLength,
  [in]      DWORD   dwFlags,
  [in]      DWORD   dwAveCharPerLine
);

Parameter-parameternya

[in] lpRemoteName

Arahkan ke nama jaringan untuk diformat.

[out] lpFormattedName

Penunjuk ke string yang menerima nama yang diformat.

[in, out] lpnLength

Penunjuk ke DWORD yang menentukan ukuran, dalam karakter, dari buffer lpFormattedName . Jika nilai pengembalian fungsi ini WN_MORE_DATA, lpnLength berisi ukuran buffer yang diperlukan, dalam karakter.

[in] dwFlags

Bitfield yang menunjukkan jenis format yang diminta. Parameter ini bisa menjadi salah satu nilai berikut.

Nilai	Meaning
WNFMT_MULTILINE	Penyedia harus menempatkan garis miring terbelakang n (\\n) di mana hentian baris akan muncul dalam nama. Nama lengkap harus diekspresikan.
WNFMT_ABBREVIATED	Penyedia harus mempersingkat nama jaringan sehingga informasi yang paling berguna untuk pengguna akan muat di ruang yang tersedia.

 

Selain itu, bendera berikut, yang bertindak sebagai pengubah pada bendera sebelumnya, dapat disertakan dengan menggunakan operasi bitwise-OR.

Nilai	Meaning
WNFMT_INENUM	Nama jaringan disajikan dalam konteks enumerasi di mana nama "kontainer" muncul segera sebelum nama jaringan dalam enumerasi. Ini memungkinkan penyedia jaringan untuk menghapus informasi berlebihan dari nama yang diformat, memberikan tampilan yang kurang berantakan untuk pengguna.

[in] dwAveCharPerLine

Menentukan jumlah rata-rata karakter yang akan pas pada satu baris di mana nama jaringan sedang disajikan. Secara khusus, nilai ini didefinisikan sebagai lebar kontrol dibagi dengan bidang tmAveCharWidth dari struktur TEXTMETRIC dari font yang digunakan untuk ditampilkan dalam kontrol.

Mengembalikan nilai

Jika fungsi berhasil, fungsi harus mengembalikan WN_SUCCESS.

Jika fungsi gagal, fungsi harus mengembalikan nilai berikut. Semua kesalahan lainnya akan diabaikan, dan nama jaringan yang tidak diformat akan digunakan.

Mengembalikan kode	Description
WN_MORE_DATA	Buffer input terlalu kecil.

Komentar

Fungsi ini memungkinkan vendor jaringan untuk memangkas atau memodifikasi nama jaringan sebelum disajikan kepada pengguna. Misalnya, dalam kotak dialog Buka umum, kotak kombo Drive menyajikan semua sumber daya yang terhubung dan nama jaringan terkait. Sebelum setiap item ditampilkan, NPFormatNetworkName dipanggil, dan penyedia jaringan memiliki opsi untuk mengedit nama sehingga akan pas di kotak kombo. Yang lebih penting, penyedia jaringan dapat mengedit nama untuk menyajikan bagian paling signifikan dari nama jaringan kepada pengguna.

Perhatikan bahwa NPFormatNetworkName tidak dirutekan ke setiap penyedia jaringan seperti sebagian besar fungsi penyedia jaringan lainnya. Setiap vendor jaringan hanya perlu khawatir tentang memformat nama jaringan mereka sendiri. Mereka dapat mengasumsikan bahwa hanya nama yang dihasilkan oleh driver penyedia jaringan mereka yang akan diteruskan ke NPFormatNetworkName.

Bendera WNFMT_ biasanya diteruskan di berbagai tempat di antarmuka pengguna seperti yang dijelaskan dalam tabel berikut. Tidak ada asumsi yang harus dibuat tentang bendera apa yang diteruskan di mana; tabel ini disediakan hanya untuk membantu setiap vendor jaringan memutuskan metode terbaik untuk memodifikasi nama jaringan mereka.

Tampilkan lokasi	WNFMT_ MULTILINE	WNFMT_ DISINGKAT	WNFMT_ INENUM
Kotak dialog Koneksi Manajer File, kotak kombo Drive , pilihan. (Bagian pilihan dari kotak kombo adalah persegi panjang atas, di atas bagian daftar, yang menampilkan pilihan saat ini.)		X
Kotak dialog Koneksi Manajer File, kotak kombo Drive , daftar. (Bagian daftar kotak kombo adalah kotak daftar yang muncul di bawah bagian pilihan kotak kombo.)	X
Manajer File, daftar Direktori Bersama .		X	X
Daftar Putuskan Sambungan Drive Jaringan Manajer File.	X
Manajer File, toolbar, kotak kombo, pilihan.		X
Manajer File, toolbar, kotak kombo, daftar.	X
Kotak dialog Buka dan Simpan Umum, kotak kombo Drive , pilihan.		X
Kotak dialog Buka dan Simpan Umum, kotak kombo Drive , daftar.		X

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows XP [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2003 [hanya aplikasi desktop]
Platform Target	Windows
Header	npapi.h
Library	davclnt.lib