IlvCOMError Class Reference

Base class for the exceptions that may be raised by the classes that encapsulate COM interfaces. More...

#include <ilviews/windows/com.h>

Inheritance diagram for IlvCOMError:

Public Member Functions
	IlvCOMError (HRESULT hr)
	Constructor. More...
DWORD	formatErrorMessage (IlString &message) const
	This member function formats a message string in relation to the error code given to the constructor. More...
HRESULT	getErrorCode () const
	This member function returns the error code. More...

Static Public Member Functions
static DWORD	FormatErrorMessage (HRESULT hr, IlString &message)
	This static member function formats a message string in relation to an error code. More...

Detailed Description

Base class for the exceptions that may be raised by the classes that encapsulate COM interfaces.

Library: ilvcom

See also

IlvCOMInterface.

Constructor & Destructor Documentation

IlvCOMError::IlvCOMError

(

HRESULT

hr

)

Constructor.

The parameter is an error code returned by Windows.

Parameters

hr

A HRESULT

Member Function Documentation

DWORD IlvCOMError::formatErrorMessage

(

IlString &

message

)

const

This member function formats a message string in relation to the error code given to the constructor.

The message string is formatted by using the Windows API function FormatMessage. The return code is the code returned by the function FormatMessage.

Parameters

message

A reference to a IlString.

Returns

A DWORD.

static DWORD IlvCOMError::FormatErrorMessage ( HRESULT  hr, IlString &  message  )

static

This static member function formats a message string in relation to an error code.

The message string is formatted by using the Windows API function FormatMessage. The return code is the code returned by the function FormatMessage.

Parameters

hr	The error code.
message	A reference to a IlString.

Returns

A DWORD.

HRESULT IlvCOMError::getErrorCode

(

)

const

This member function returns the error code.

Returns

A HRESULT.