File : gnatcom-ierrorinfo.ads
------------------------------------------------------------------------------
-- --
-- GNATCOM - Ada 95 COM/DCOM/COM+ Development Framework and Tools --
-- --
-- G N A T C O M . I E R R O R I N F O --
-- --
-- S p e c --
-- --
-- $Revision: 1.3 $
-- --
-- Copyright (C) 1999, 2000, 2001 David Botton --
-- --
-- This is free software; you can redistribute it and/or modify it under --
-- terms of the GNU General Public License as published by the Free Soft- --
-- ware Foundation; either version 2, or (at your option) any later ver- --
-- sion. It is distributed in the hope that it will be useful, but WITHOUT --
-- ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or --
-- FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
-- for more details. You should have received a copy of the GNU General --
-- Public License distributed with this; see file COPYING. If not, write --
-- to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, --
-- MA 02111-1307, USA. --
-- --
-- As a special exception, if other files instantiate generics from this --
-- unit, or you link this unit with other files to produce an executable, --
-- this unit does not by itself cause the resulting executable to be --
-- covered by the GNU General Public License. This exception does not --
-- however invalidate any other reasons why the executable file might be --
-- covered by the GNU Public License. --
-- --
-- More information about GNATCOM and the most current public version can --
-- be located on the web at http://www.adapower.com/gnatcom --
-- --
-- Support for GNATCOM is available from Ada Core Technologies, Inc. --
-- --
-- In the U.S., contact Ada Core Technologies at: --
-- Tel: +1 (212) 620 7300 ext 117 --
-- Fax: +1 (212) 807 0162 --
-- Email: sales@gnat.com --
-- --
-- In Europe and elsewhere, contact ACT Europe at: --
-- Tel: +33 1 49 70 67 16 --
-- Fax: +33 1 49 70 05 52 --
-- Email: sales@act-europe.fr --
------------------------------------------------------------------------------
with Ada.Strings.Unbounded;
with GNATCOM.Types;
with GNATCOM.Interface;
package GNATCOM.IErrorInfo is
procedure Create_IErrorInfo
(Description : in String;
Source_PROGID : in String := "";
Associated_GUID : in GNATCOM.Types.GUID := GNATCOM.Types.GUID_NULL;
Help_Context : in GNATCOM.Types.DWORD := 0;
Help_File_Path : in String := "");
-- Creates and associates and Error object with this method invocation
-- and thread
--
-- It is used in COM servers to create a COM error that can
-- then be retrieved through Get_IErrorInfo or the Win32 API
-- function GetErrorInfo when a COM call has failed.
--
-- To support IErrorInfo in your COM server each object that will
-- be generating IErrorInfos for failure situations should include
-- the interface ISupportErrorInfo. The InterfaceSupportsErrorInfo
-- method should be implemented to return S_OK for each interface
-- passed to it that will be creating IErrorInfos and S_FALSE for
-- those not creating IErrorInfos
function Supports_IErrorInfo
(Object : in GNATCOM.Interface.Interface_Type'Class)
return Boolean;
-- Checks to see if IErrorInfos will be generated for this interface
-- on the object. It does a Query for ISupportErrorInfo and then
-- executes the InterfaceSupportsErrorInfo passing in the IID assigned
-- to Object. This should be run before doing a Get_IErrorInfo
function Get_IErrorInfo return String;
-- Return just the description field of the IErrorInfo object of the
-- last COM method error posted to this calling thread
--
-- Note: When using IDispatch based bindings (*_Object.ads) or the
-- GNATCOM.Dispinterface package, IErrorInfos thrown will
-- be unavailable through Get_IErrorInfo since they will
-- have been captured by the OS. The Source_PROGID and the
-- Description fields will be returned as part of the
-- GNATCOM.Dispinterface.Invoke_Error error message
procedure Get_IErrorInfo
(Description : out Ada.Strings.Unbounded.Unbounded_String;
Source_PROGID : out Ada.Strings.Unbounded.Unbounded_String;
Associated_GUID : out GNATCOM.Types.GUID;
Help_Context : out GNATCOM.Types.DWORD;
Help_File_Path : out Ada.Strings.Unbounded.Unbounded_String);
-- Return the values of the IErrorInfo of the last COM method error
-- posted to this calling thread
--
-- Note: When using IDispatch based bindings (*_Object.ads) or the
-- GNATCOM.Dispinterface package, IErrorInfos thrown will
-- be unavailable through Get_IErrorInfo since they will
-- have been captured by the OS. The Source_PROGID and the
-- Description fields will be returned as part of the
-- GNATCOM.Dispinterface.Invoke_Error error message
end GNATCOM.IErrorInfo;