Open Core Interface - MLPI
MLPI-MotionLogicProgrammingInterface(mlpi4COM)  1.26.2
IModule.idl
Go to the documentation of this file.
1 // -----------------------------------------------------------------------
2 // MLPI - <IModule.idl>
3 // -----------------------------------------------------------------------
4 // Copyright (c) 2012 Bosch Rexroth. All rights reserved.
5 // Redistribution and use in source and binary forms of this MLPI software
6 // (SW) provided to you, with or without modification, are permitted
7 // without prior approval provided that the following conditions are met:
8 //
9 // 1. Redistributions of source code of SW must retain the above copyright
10 // notice, this list of conditions and the following disclaimer.
11 //
12 // 2. Redistributions in binary form of SW must reproduce the above copyright
13 // notice, this list of conditions and the following disclaimer in the
14 // documentation and/or other materials provided with the distribution.
15 //
16 // 3. User recognizes and acknowledges that it acquires no right,
17 // title or interest in or to any of the names or trademarks used in
18 // connection with the SW ("names") by virtue of this License and waives
19 // any right to or interest in the names. User recognizes and acknowledges
20 // that names of companies or names or products of companies displayed
21 // in the documentation of SW to indicate the interoperability of products
22 // with the SW are the names of their respective owners. The use of such
23 // names in the documentation of SW does not imply any sponsorship,
24 // approval, or endorsement by such companies of this product.
25 //
26 // 4. Modified code versions, i.e. any addition to or deletion from
27 // the substance or structure of the original code of the SW running
28 // the MLPI must be plainly marked as such and must not be misrepresented
29 // as being original SW.
30 //
31 // 5. The SW may only be used in connection with a Bosch Rexroth product.
32 //
33 // THIS INFORMATION IS PROVIDED BY BOSCH REXROTH CORPORATION "AS IS"
34 // AND WITHOUT WARRANTY OF ANY KIND, EXPRESSED OR IMPLIED, INCLUDING
35 // (BUT NOTLIMITED TO) ANY IMPLIED WARRANTIES OF MERCHANTABILITY,
36 // FITNESS FOR ANY PARTICULAR PURPOSE, OR NON-INFRINGEMENT. WHILE THE
37 // INFORMATION PROVIDED IS BELIEVED TO BE ACCURATE, IT MAY INCLUDE
38 // ERRORS OR INACCURACIES.
39 // SUBJECT TO COMPULSORY STATUTORY PROVISIONS OF THE GERMAN LAW AS
40 // THE APPLICABLE LAW FOR THIS LICENSE BOSCH REXROTH CORPORATION WILL
41 // NOT BE LIABLE FOR ANY DAMAGES OF ANY KIND ARISING FROM THE USE OF
42 // THE SOFTWARE DISTRIBUTED HEREUNDER, INCLUDING BUT NOT LIMITED TO
43 // DIRECT, INDIRECT, INCIDENTAL, PUNITIVE, AND CONSEQUENTIAL DAMAGES.
44 // -----------------------------------------------------------------------
45 //
55 //
56 // -----------------------------------------------------------------------
57 
58 
59 
63 [
64  object,
65  uuid(BF28903F-0F4D-401b-B000-054174EAC277),
66  dual,
67  nonextensible,
68  helpstring("IModule Interface"),
69  pointer_default(unique)
70 ]
71 interface IModule : IDispatch{
72 
73  [propget, id(1), helpstring("Property NameOfModule")] HRESULT NameOfModule([out, retval] BSTR* nameOfModule);
74 
84  [id(2), helpstring("Method ActivateModule")] HRESULT ActivateModule(void);
85 
95  [id(3), helpstring("Method DeactivateModule")] HRESULT DeactivateModule(void);
96 
118  [id(4), helpstring("Method Message")] HRESULT Message([in] BSTR text, [in] BSTR functionName, [in] LONG lineNumber);
119 
141  [id(5), helpstring("Method Warning")] HRESULT Warning([in] BSTR text, [in] BSTR functionName, [in] LONG lineNumber);
142 
164  [id(6), helpstring("Method Error")] HRESULT Error([in] BSTR text, [in] BSTR functionName, [in] LONG lineNumber);
165 
187  [id(7), helpstring("Method Event")] HRESULT Event([in] BSTR text, [in] BSTR functionName, [in] LONG lineNumber);
188 
189 
190 };
191 
192 // -----------------------------------------------------------------------
193 // HISTORY
194 // -----------------------------------------------------------------------
195 // 01-Jan-2012
196 // - first release
197 //
198 
199 
200 
201 
202 
HRESULT Event([in] BSTR text, [in] BSTR functionName, [in] LONG lineNumber)
This function traces an event to the given module.
HRESULT Message([in] BSTR text, [in] BSTR functionName, [in] LONG lineNumber)
This function traces a message to the given module.
HRESULT DeactivateModule(void)
This function deactivates the given module. Only modules which are activated insert messages into a t...
HRESULT ActivateModule(void)
This function activates the given module. Only modules which are activated insert messages into a tra...
HRESULT Error([in] BSTR text, [in] BSTR functionName, [in] LONG lineNumber)
This function traces an error to the given module.
Definition of the IModule interface to access a single trace module.
Definition: IModule.idl:71
HRESULT Warning([in] BSTR text, [in] BSTR functionName, [in] LONG lineNumber)
This function traces a warning to the given module.