Fungsi RoOriginateError (roerrorapi.h)

  • Artikel

Melaporkan kesalahan dan string informatif ke debugger yang dilampirkan.

Sintaks

BOOL RoOriginateError(
  [in] HRESULT error,
  [in] HSTRING message
);

Parameter

[in] error

Jenis: HRESULT

Kode kesalahan yang terkait dengan kondisi kesalahan. Jika kesalahan adalah kode keberhasilan, seperti S_OK, fungsi tidak berpengaruh dan mengembalikan FALSE. Perilaku ini memungkinkan pemanggilan fungsi ketika tidak ada kesalahan yang terjadi tanpa menyebabkan pesan kesalahan yang tidak diinginkan.

[in] message

Jenis: HSTRING

String informatif untuk membantu pengembang memperbaiki kondisi kesalahan yang dilaporkan. Panjang maksimum adalah 512 karakter, termasuk karakter NUL berikutnya; untai (karakter) yang lebih panjang dipotok.

Jika string kosong, fungsi berhasil tetapi tidak ada informasi kesalahan yang dilaporkan. Disarankan agar Anda selalu memberikan string informatif.

Jika pesanNULL, fungsi berhasil dan melaporkan string generik di Winerror.h jika tersedia atau string generik yang terkait dengan E_FAIL.

Fungsi ini tidak mendukung karakter NUL yang disematkan, jadi hanya karakter sebelum NUL pertama yang dilaporkan.

String pesan harus dilokalkan.

Nilai kembali

Jenis: BOOL

Menampilkan kode Deskripsi
TRUE
 Pesan kesalahan berhasil dilaporkan.
FALSE
 pesan adalah NULL atau menunjuk ke string kosong, atau kesalahan adalah kode keberhasilan.

Keterangan

Gunakan fungsi RoOriginateError untuk melaporkan kondisi kesalahan dan pesan terkait ke debugger. Fungsi ini tidak melakukan pengelogan atau pelacakan peristiwa.

Kesalahan dikomunikasikan ke debugger dengan menaikkan pengecualian terstruktur. Pengecualian ini ditangkap oleh debugger terlampir, dan parameter pengecualian berisi kesalahan dan string pesan . Debugger dapat menampilkan parameter ini kepada pengguna.

Bergantung pada konfigurasi debugger saat ini, fungsi RoOriginateError dapat menyebabkan eksekusi berhenti di debugger di situs pengecualian.

Jika bendera UseSetErrorInfo diatur dengan memanggil fungsi RoSetErrorReportingFlags , dan utas panggilan telah diinisialisasi di COM, fungsi membuat objek kesalahan yang sesuai yang mendukung IRestrictedErrorInfo dan mengaitkannya dengan saluran COM dengan memanggil SetErrorInfo. Jika utas belum diinisialisasi ke COM, panggilan akan tetap berhasil tanpa kesalahan, tetapi kesalahan tidak akan dikaitkan dengan saluran COM.

Persyaratan

Persyaratan Nilai
Klien minimum yang didukung Windows 8 [aplikasi desktop | Aplikasi UWP]
Server minimum yang didukung Windows Server 2012 [aplikasi desktop | Aplikasi UWP]
Target Platform Windows
Header roerrorapi.h
Pustaka RuntimeObject.lib

Lihat juga

RO_ERROR_REPORTING_FLAGS

RoGetErrorReportingFlags

RoOriginateErrorW

RoSetErrorReportingFlags

RoTransformError