ITrace.idl

Go to the documentation of this file.

// -----------------------------------------------------------------------
// MLPI - <ITrace.idl>
// -----------------------------------------------------------------------
// Copyright (c) 2012 Bosch Rexroth. All rights reserved.
// Redistribution and use in source and binary forms of this MLPI software
// (SW) provided to you, with or without modification, are permitted
// without prior approval provided that the following conditions are met:
//
// 1. Redistributions of source code of SW must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form of SW must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. User recognizes and acknowledges that it acquires no right,
// title or interest in or to any of the names or trademarks used in
// connection with the SW ("names") by virtue of this License and waives
// any right to or interest in the names. User recognizes and acknowledges
// that Names of companies or names or products of companies displayed
// in the documentation of SW to indicate the interoperability of products
// with the SW are the names of their respective owners. The use of such
// names in the documentation of SW does not imply any sponsorship,
// approval, or endorsement by such companies of this product.
//
// 4. Modified code versions, i.e. any addition to or deletion from
// the substance or structure of the original code of the SW running
// the MLPI must be plainly marked as such and must not be misrepresented
// as being original SW.
//
// 5. The SW may only be used in connection with a Bosch Rexroth product.
//
// THIS INFORMATION IS PROVIDED BY BOSCH REXROTH CORPORATION "AS IS"
// AND WITHOUT WARRANTY OF ANY KIND, EXPRESSED OR IMPLIED, INCLUDING
// (BUT NOTLIMITED TO) ANY IMPLIED WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR ANY PARTICULAR PURPOSE, OR NON-INFRINGEMENT. WHILE THE
// INFORMATION PROVIDED IS BELIEVED TO BE ACCURATE, IT MAY INCLUDE
// ERRORS OR INACCURACIES.
// SUBJECT TO COMPULSORY STATUTORY PROVISIONS OF THE GERMAN LAW AS
// THE APPLICABLE LAW FOR THIS LICENSE BOSCH REXROTH CORPORATION WILL
// NOT BE LIABLE FOR ANY DAMAGES OF ANY KIND ARISING FROM THE USE OF
// THE  SOFTWARE  DISTRIBUTED HEREUNDER, INCLUDING BUT NOT LIMITED TO
// DIRECT, INDIRECT, INCIDENTAL, PUNITIVE, AND CONSEQUENTIAL DAMAGES.
// -----------------------------------------------------------------------
//
//
// -----------------------------------------------------------------------



[
  object,
  uuid(4C8AEA66-5C10-46e6-820C-32CF5A9FD3CC),
  dual,
  nonextensible,
  helpstring("ITrace Interface"),
  pointer_default(unique)
]
interface ITrace : IDispatch{


#if defined(WIN32) || defined(WIN64)
  [
    uuid(9E18BE35-8B19-4e7f-A25A-C6451D90C1C2)
  ]
  struct TraceModuleInformation
  {
    VARIANT isActive;         
    VARIANT toStdOut;         
    VARIANT toMainBuffer;     
    VARIANT toSeparateBuffer; 
    BSTR    moduleName;       
    BSTR    bufferName;       
  };

  [
    uuid(5DD3E9BB-7043-45ec-A837-A879C7F86873)
  ]
  struct TraceBufferInformation
  {
    BSTR     bufferName;        
    LONG     maximumBufferSize; 
    LONG     actualBufferSize;  
    VARIANT  isLocked;          
  };
#endif

  [propget, id(1), helpstring("Property Modules")] HRESULT Modules([out, retval] IModules** modules);

  [propget, id(2), helpstring("Property Buffers")] HRESULT Buffers([out, retval] IBuffers** buffers);

  [id(3), helpstring("Method ActivateAllModules")] HRESULT ActivateAllModules(void);

  [id(4), helpstring("Method DeactivateAllModules")] HRESULT DeactivateAllModules(void);

  [id(5), helpstring("Method GetNumberOfModules")] HRESULT GetNumberOfModules([out, retval] LONG *numberOfModules);

  [id(6), helpstring("Method GetNumberOfBuffers")] HRESULT GetNumberOfBuffers([out, retval] LONG *numberOfBuffers);

#if defined(WIN32) || defined(WIN64)
  [id(7), helpstring("Method GetModuleList")] HRESULT GetModuleList([out, retval] SAFEARRAY (struct TraceModuleInformation) *traceInfo);

  [id(8), helpstring("Method GetBufferList")] HRESULT GetBufferList([out, retval] SAFEARRAY (struct TraceBufferInformation) *traceInfo);
#endif

  [id(9), helpstring("Method ClearAllBuffers")] HRESULT ClearAllBuffers(void);
};



// -----------------------------------------------------------------------
// HISTORY
// -----------------------------------------------------------------------
// 01-Jan-2012
//   - first release
//