winrt::hresult_error struct (C++/WinRT)
Jenis yang mewakili kode kesalahan HRESULT.
Sintaks
struct hresult_error
Persyaratan
SDK minimum yang didukung: Windows SDK versi 10.0.17134.0 (Windows 10, versi 1803)
Namespace: winrt
Header: %WindowsSdkDir%Include<WindowsTargetPlatformVersion>\cppwinrt\winrt\base.h (disertakan secara default)
Konstruktor
Konstruktor | Deskripsi |
---|---|
konstruktor hresult_error::hresult_error | Menginisialisasi instans baru struct hresult_error dengan salinan data input. |
Jenis
Konstruktor | Deskripsi |
---|---|
jenis hresult_error::from_abi_t | Jenis anggota data statis hresult_error::from_abi . |
Anggota data statis
Fungsi | Deskripsi |
---|---|
hresult_error::from_abi anggota data statis | Instans jenis hresult_error::from_abi_t, yang dapat diteruskan ke konstruktor hresult_error (atau jenis turunan) untuk menunjukkan bahwa konstruktor harus mencoba mengambil info kesalahan terbatas. |
Fungsi anggota
Fungsi | Deskripsi |
---|---|
hresult_error::code function | Mengambil kode untuk kesalahan yang diwakili oleh objek hresult_error . |
hresult_error::message function | Mengambil pesan untuk kesalahan yang diwakili oleh objek hresult_error . |
fungsi hresult_error::to_abi | Mengatur objek informasi kesalahan terbatas untuk utas saat ini, dan mengembalikan kode untuk kesalahan yang diwakili oleh objek hresult_error . |
fungsi hresult_error::try_as | Mengembalikan antarmuka yang diminta, jika didukung. Mengembalikan nullptr , atau false , jika tidak. |
Operator anggota
Operator | Deskripsi |
---|---|
hresult_error::operator= (operator penugasan) | Menetapkan nilai ke objek hresult_error . |
konstruktor hresult_error::hresult_error
Menginisialisasi instans baru struct hresult_error dengan salinan data input.
Sintaks
hresult_error() noexcept;
hresult_error(hresult_error&&);
hresult_error(hresult_error const& other);
explicit hresult_error(HRESULT const code) noexcept;
hresult_error(HRESULT const code, winrt::hstring const& message, ::IUnknown* object = nullptr) noexcept;
hresult_error(HRESULT const code, winrt::hresult_error::from_abi_t) noexcept;
Parameter
other
Hresult_error lain yang menginisialisasi objek hresult_error.
code
Kode HRESULT yang menginisialisasi objek hresult_error .
message
String informatif untuk membantu pengembang memperbaiki kondisi kesalahan yang dilaporkan.
object
Objek kesalahan yang menyimpan informasi tambahan tentang kesalahan tersebut. Objek kesalahan harus agile apartemen, in-proc, dan marshal-by-value di seluruh proses. Ini harus mengimplementasikan ILanguageExceptionStackBackTrace dan ILanguageExceptionTransform jika perlu. Lihat RoOriginateLanguageException.
hresult_error::code function
Mengambil kode untuk kesalahan yang diwakili oleh objek hresult_error .
Sintaks
winrt::hresult code() const noexcept;
Mengembalikan nilai
Kode kesalahan winrt::hresult .
hresult_error::from_abi anggota data statis
Instans jenis hresult_error::from_abi_t, yang dapat diteruskan ke konstruktor hresult_error (atau jenis turunan) untuk menunjukkan bahwa konstruktor harus mencoba mengambil info kesalahan terbatas.
Sintaks
static constexpr winrt::hresult_error::from_abi_t from_abi{};
jenis hresult_error::from_abi_t
Jenis anggota data statis hresult_error::from_abi .
Sintaks
struct from_abi_t {};
hresult_error::message function
Mengambil pesan untuk kesalahan yang diwakili oleh objek hresult_error .
Sintaks
winrt::hstring message() const noexcept;
Mengembalikan nilai
Winrt::hstring yang berisi pesan kesalahan.
hresult_error::operator= (operator penugasan)
Menetapkan nilai ke objek hresult_error .
Sintaks
winrt::hresult_error& operator=(winrt::hresult_error&&);
winrt::hresult_error& operator=(winrt::hresult_error const& other) noexcept;
Parameter
other
Nilai hresult_error untuk ditetapkan ke objek hresult_error .
Mengembalikan nilai
Referensi ke objek hresult_error .
fungsi hresult_error::to_abi
Mengatur objek informasi kesalahan terbatas untuk utas saat ini, dan mengembalikan kode untuk kesalahan yang diwakili oleh objek hresult_error .
Sintaks
HRESULT to_abi() const noexcept;
Mengembalikan nilai
Kode kesalahan HRESULT.
fungsi hresult_error::try_as
Mengembalikan antarmuka yang diminta, jika didukung. Mengembalikan nullptr
jika tidak. Fungsi ini berguna jika Anda ingin mengkueri antarmuka yang tidak perlu Anda teruskan kembali ke pemanggil Anda. Misalnya, Anda dapat mengambil IRestrictedErrorInfo untuk mengakses info kesalahan terbatas untuk kesalahan yang diwakili oleh objek hresult_error .
Sintaks
template <typename To> auto try_as() const noexcept;
Parameter templat
typename To
Jenis antarmuka yang diminta.
Parameter
to
Referensi ke nilai untuk menerima antarmuka yang diminta.
Mengembalikan nilai
Winrt::com_ptr mereferensikan antarmuka yang diminta, atau penunjuk cerdas yang ditik dengan kuat untuk antarmuka yang diminta (baik dinyatakan oleh C++/WinRT atau oleh pihak ketiga), jika antarmuka yang diminta didukung, jika tidak nullptr
.