Metode IXpsOMCanvas::GetAccessibilityLongDescription (xpsobjectmodel.h)

Mendapatkan deskripsi tekstual panjang (terperinci) dari konten objek. Teks ini digunakan oleh klien aksesibilitas untuk menjelaskan objek.

Sintaks

HRESULT GetAccessibilityLongDescription(
  [out, retval] LPWSTR *longDescription
);

Parameter

[out, retval] longDescription

Deskripsi tekstual panjang (terperinci) dari konten objek. Penunjuk NULL dikembalikan jika teks ini belum diatur.

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	longDescriptionadalah NULL.

Keterangan

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

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

Persyaratan

Persyaratan	Nilai
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