Metode IXpsOMCanvas::GetAccessibilityShortDescription (xpsobjectmodel.h)

Mendapatkan deskripsi tekstual singkat tentang konten objek. Teks ini digunakan oleh klien aksesibilitas untuk menjelaskan objek.

Sintaks

HRESULT GetAccessibilityShortDescription(
  [out, retval] LPWSTR *shortDescription
);

Parameter

[out, retval] shortDescription

Deskripsi tekstual singkat dari konten objek. Jika deskripsi ini tidak diatur, penunjuk NULL dikembalikan.

Nilai kembali

Metode mengembalikan HRESULT. Nilai yang mungkin termasuk, tetapi tidak terbatas pada, yang ada dalam tabel berikut. Untuk informasi tentang nilai pengembalian API dokumen XPS yang tidak tercantum dalam tabel ini, lihat Kesalahan Dokumen XPS.

Menampilkan kode	Deskripsi
S_OK	Metode berhasil.
E_POINTER	shortDescription adalah NULL.

Keterangan

Properti yang dikembalikan oleh metode ini sesuai dengan atribut AutomationProperties.Name elemen Canvas dalam markup dokumen.

Metode ini mengalokasikan memori yang digunakan oleh string yang dikembalikan dalam shortDescription. Jika shortDescription bukan NULL, gunakan fungsi CoTaskMemFree untuk membebaskan memori.

Persyaratan

Klien minimum yang didukung	Windows 7, Windows Vista dengan SP2 dan Pembaruan Platform untuk Windows Vista [aplikasi desktop | Aplikasi UWP]
Server minimum yang didukung	Windows Server 2008 R2, Windows Server 2008 dengan SP2 dan Pembaruan Platform untuk Windows Server 2008 [aplikasi desktop | Aplikasi UWP]
Target Platform	Windows
Header	xpsobjectmodel.h

Lihat juga

IXpsOMCanvas

Spesifikasi Kertas XML

Kesalahan Dokumen XPS