Fungsi GetNames

Mengambil subset atau semua nama properti objek.

Catatan

API ini hanya untuk penggunaan internal. API ini tidak dimaksudkan untuk digunakan dari kode pengembang.

Sintaks

HRESULT GetNames (
   [in] int                 vFunc,
   [in] IWbemClassObject*   ptr,
   [in] LPCWSTR             wszQualifierName,
   [in] LONG                lFlags,
   [in] VARIANT*            pQualifierValue,
   [out] SAFEARRAY (BSTR)** pstrNames
);

Parameter

vFunc
[in] Parameter ini tidak digunakan.

ptr
[in] Penunjuk ke instans IWbemClassObject.

wszQualifierName
[in] Penunjuk ke LPCWSTR valid yang menentukan nama kualifikasi yang beroperasi sebagai bagian dari filter. Untuk informasi selengkapnya, lihat bagian Keterangan. Parameter ini dapat berupa null.

lFlags
[in] Kombinasi bidang bit. Untuk informasi selengkapnya, lihat bagian Keterangan.

pQualifierValue [in] Penunjuk ke struktur VARIANT valid yang diinisialisasi ke nilai filter. Parameter ini dapat berupa null.

pstrNames
[out] Struktur SAFEARRAY yang berisi nama properti. Pada entri, parameter ini harus selalu menjadi penunjuk ke null. Untuk informasi selengkapnya, lihat bagian Keterangan.

Mengembalikan nilai

Nilai berikut yang dikembalikan oleh fungsi ini ditentukan dalam file header WbemCli.h, atau Anda dapat menentukannya sebagai konstanta dalam kode Anda:

Terus-menerus	Nilai	Deskripsi
WBEM_E_FAILED	0x80041001	Terjadi kegagalan umum.
WBEM_E_INVALID_PARAMETER	0x80041008	Satu atau beberapa parameter tidak valid, atau kombinasi bendera dan parameter yang salah ditentukan.
WBEM_E_OUT_OF_MEMORY	0x80041006	Memori tidak cukup tersedia untuk menyelesaikan operasi.
WBEM_S_NO_ERROR	0	Panggilan fungsi berhasil.

Keterangan

Fungsi ini membungkus panggilan ke metode IWbemClassObject::GetNames.

Nama yang dikembalikan dikontrol oleh kombinasi bendera dan parameter. Misalnya, fungsi dapat mengembalikan nama semua properti atau nama properti kunci saja. Filter utama ditentukan dalam parameter lFlags, dan parameter lainnya bervariasi tergantung pada filter tersebut.

Nilai bendera di lFlags adalah bidang bit

Bendera yang dapat diteruskan sebagai argumen lEnumFlags adalah bidang bit yang ditentukan dalam file header WbemCli.h, atau Anda dapat menentukannya sebagai konstanta dalam kode Anda. Anda dapat menggabungkan satu bendera dari setiap grup dengan bendera apa pun dari grup lain. Namun, bendera dari grup yang sama saling eksklusif.

Bendera grup 1	Nilai	Deskripsi
WBEM_FLAG_ALWAYS	0	Mengembalikan semua nama properti. strQualifierName dan pQualifierVal tidak digunakan.
WBEM_FLAG_ONLY_IF_TRUE	1	Hanya mengembalikan properti yang memiliki kualifikasi nama yang ditentukan oleh parameter strQualifierName. Jika bendera ini digunakan, Anda harus menentukan strQualifierName.
WBEM_FLAG_ONLY_IF_FALSE	2	Hanya mengembalikan properti yang tidak memiliki kualifikasi nama yang ditentukan oleh parameter strQualifierName. Jika bendera ini digunakan, Anda harus menentukan strQualifierName.
WBEM_FLAG_ONLY_IF_IDENTICAL	3	Hanya mengembalikan properti yang memiliki kualifikasi nama yang ditentukan oleh parameter wszQualifierName dan juga memiliki nilai yang identik dengan yang ditentukan oleh struktur pQualifierVal. Jika bendera ini digunakan, Anda harus menentukan wszQualifierName dan pQualifierValue.

Bendera grup 2	Nilai	Deskripsi
WBEM_FLAG_KEYS_ONLY	0x4	Hanya mengembalikan nama properti yang menentukan kunci.
WBEM_FLAG_REFS_ONLY	0x8	Hanya mengembalikan nama properti yang merupakan referensi objek.

Bendera grup 3	Nilai	Deskripsi
WBEM_FLAG_LOCAL_ONLY	0x10	Hanya mengembalikan nama properti yang termasuk dalam kelas yang paling diturunkan. Kecualikan properti dari kelas induk.
WBEM_FLAG_PROPAGATED_ONLY	0x20	Hanya mengembalikan nama properti yang termasuk dalam kelas induk.
WBEM_FLAG_SYSTEM_ONLY	0x30	Hanya mengembalikan nama properti sistem.
WBEM_FLAG_NONSYSTEM_ONLY	0x40	Hanya mengembalikan nama properti non-sistem.

Fungsi selalu mengalokasikan SAFEARRAY baru jika mengembalikan WBEM_S_NO_ERROR, dan pstrNames selalu diatur untuk mengarahkannya. Array yang dikembalikan dapat memiliki 0 elemen jika tidak ada properti yang cocok dengan filter yang ditentukan. Jika fungsi mengembalikan nilai selain WBM_S_NO_ERROR, struktur SAFEARRAY baru tidak dikembalikan.

Persyaratan

Platform: Lihat Persyaratan Sistem.

Header: WMINet_Utils.idl

Versi .NET Framework: Tersedia sejak 4.7.2

Lihat juga

• WMI dan Penghitung Kinerja (Referensi API Tidak Terkelola)