Fungsi GetNtmsUIOptionsA (ntmsapi.h)

[ Manajer Penyimpanan yang Dapat Dilepas tidak lagi tersedia pada Windows 7 dan Windows Server 2008 R2.]

Fungsi GetNtmsUIOptions mendapatkan daftar nama komputer tempat jenis antarmuka pengguna yang ditentukan diarahkan untuk objek yang diberikan. Panggilan ke GetNtmsUIOptions mengembalikan daftar tujuan untuk instans yang ditentukan oleh parameter lpObjectId dan dwType.

Jika tidak ada tujuan dalam daftar untuk instans yang ditentukan, fungsi mengembalikan ERROR_SUCCESS bersama dengan panjang daftar nol.

Sintaksis

DWORD GetNtmsUIOptionsA(
  [in]      HANDLE            hSession,
  [in]      const LPNTMS_GUID lpObjectId,
  [in]      DWORD             dwType,
  [out]     LPSTR             lpszDestination,
  [in, out] LPDWORD           lpdwBufSize
);

Parameter

[in] hSession

Tangani ke sesi yang dikembalikan oleh fungsi OpenNtmsSession.

[in] lpObjectId

Pengidentifikasi unik objek yang UI-nya sedang dialihkan. Objek harus berupa kontainer yang dapat menjadi sumber peristiwa. Objek dapat berupa aplikasi (permintaan pemasangan yang dipicu oleh aplikasi), pustaka (permintaan buka pintu sebagai respons terhadap eject) atau komputer (semua UI yang berkaitan dengan komputer).

Untuk menentukan kontainer komputer, atur lpObjectId pointer untuk menunjuk ke buffer dengan GUID objek komputer Manajer Penyimpanan yang Dapat Dilepas. Untuk menentukan pustaka tertentu, atur untuk menunjuk ke buffer dengan GUID pustaka. Untuk menentukan aplikasi, teruskan penunjuk NULL . Identitas aplikasi ditentukan oleh sesi yang digunakan dalam hSession. Perhatikan bahwa aplikasi dapat membuka beberapa sesi secara bersamaan. Dalam hal ini, kumpulan nilai hanya berlaku untuk sesi hSession .

[in] dwType

Parameter ini dapat memiliki salah satu nilai berikut.

Nilai Arti
NTMS_UITYPE_INFO
 Pesan UI yang memberikan informasi. Ini termasuk item antrean kerja yang menunjukkan kemajuan. Misalnya, permintaan pemasangan.
NTMS_UITYPE_REQ
 Pesan UI yang merupakan permintaan. Ini termasuk permintaan operator yang menangani media. Misalnya, permintaan untuk menyuntikkan media baru.
NTMS_UITYPE_ERR
 Pesan UI yang memberikan informasi kesalahan. Ini termasuk permintaan operator yang terkait dengan pemberitahuan kesalahan. Misalnya, permintaan untuk membersihkan drive.

[out] lpszDestination

Multi-string yang mengembalikan nama komputer tempat UI dialihkan. Parameter ini tidak dapat null.

[in, out] lpdwBufSize

Ukuran string tujuan, dalam TCHAR.

Mengembalikan nilai

Fungsi ini mengembalikan salah satu nilai berikut.

Nilai Arti
ERROR_ACCESS_DENIED
 Akses ke satu atau beberapa objek RSM ditolak.
ERROR_INSUFFICIENT_BUFFER
 Ukuran buffer yang ditentukan oleh lpdwSize terlalu kecil untuk tujuan yang ditemukan. Fungsi mengembalikan ukuran aktual dalam lpdwSize.
ERROR_INVALID_HANDLE
 Handel sesi hilang atau tidak valid.
ERROR_INVALID_PARAMETER
 Parameter lpdwSize atau lpszDestination NULL, atau lpObjectId bukan kontainer yang valid, atau dwType bukan salah satu dari tiga nilai yang valid.
ERROR_NOT_ENOUGH_MEMORY
 Kegagalan alokasi terjadi selama pemrosesan.
ERROR_OBJECT_NOT_FOUND
 GUID yang ditentukan oleh lpObjectId bukan GUID dari komputer atau objek pustaka apa pun dalam database.
ERROR_SUCCESS
 Fungsi berhasil.

Komentar

Panggilan ke GetNtmsUIOptions mengembalikan daftar tujuan untuk instans tertentu yang ditentukan oleh lpObjectId dan parameter dwType.

  NTMS_UITYPE_INFO NTMS_UITYPE_REQ NTMS_UITYPE_ERR
Aplikasi Tampilkan UI kemajuan item kerja untuk item kerja yang dihasilkan oleh aplikasi ini. Tampilkan antarmuka pengguna permintaan operator untuk permintaan operator yang dihasilkan oleh tindakan yang diambil oleh aplikasi ini. Undefined. Aplikasi tidak dapat menyebabkan kejadian kesalahan semacam ini.
Perpustakaan Tampilkan UI kemajuan item kerja untuk item kerja yang terkait dengan pustaka ini. Tampilkan UI untuk permintaan yang terkait dengan pustaka ini. Tampilkan UI untuk kesalahan yang terkait dengan pustaka ini.
Komputer Tampilkan UI informasi dalam contoh RSM yang berjalan pada komputer ini. Tampilkan UI jenis permintaan dalam contoh RSM ini. Tampilkan antarmuka pengguna jenis kesalahan dalam contoh RSM ini.
 

Nota

Header ntmsapi.h mendefinisikan GetNtmsUIOptions sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta preprosektor UNICODE. Mencampur penggunaan alias encoding-netral dengan kode yang tidak mengodekan-netral dapat menyebabkan ketidakcocokan yang mengakibatkan kesalahan kompilasi atau runtime. Untuk informasi selengkapnya, lihat Konvensi untuk Prototipe Fungsi.

Persyaratan

Syarat Nilai
klien minimum yang didukung Windows XP [hanya aplikasi desktop]
server minimum yang didukung Windows Server 2003 [hanya aplikasi desktop]
Platform Target Windows
Header ntmsapi.h
Pustaka Ntmsapi.lib
DLL Ntmsapi.dll

Lihat juga

Fungsi Kontrol Pustaka

SetNtmsUIOptions

  • Last updated on