IBuffer.idl

Go to the documentation of this file.

// -----------------------------------------------------------------------
// MLPI - <IBuffer.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(0B87C392-EDFE-497c-BCE1-47DD00217178),
  dual,
  nonextensible,
  helpstring("IBuffer Interface"),
  pointer_default(unique)
]
interface IBuffer : IDispatch{

  typedef [v1_enum] enum TraceType
  {
    TRACE_TYPE_OTHER     = 0,               
    TRACE_TYPE_MESSAGE   = 1,               
    TRACE_TYPE_WARNING   = 2,               
    TRACE_TYPE_ERROR     = 3                
  }TraceType;

#if defined(WIN32) || defined(WIN64)
  [
    uuid(28B7FD1A-1DAE-4446-9BB8-9A3C3BDF8791)
  ]
  struct TraceMessage
  {
    LONGLONG   index;             
    TraceType  type;              
    LONG       milliseconds;      
    LONG       lineNumber;        
    LONG       threadId;          
    BSTR       text;              
    BSTR       moduleName;        
    BSTR       functionName;      
  };
#endif

  [propget, id(1), helpstring("Property NameOfBuffer")] HRESULT NameOfBuffer([out, retval] BSTR* bufferName);


  [id(2), helpstring("Method GetNewestMessageIndex")] HRESULT GetNewestMessageIndex([out, retval] LONGLONG *newestIndex);

  [id(3), helpstring("Method GetOldestMessageIndex")] HRESULT GetOldestMessageIndex([out, retval] LONGLONG *oldestIndex);

#if defined(WIN32) || defined(WIN64)
  [id(4), helpstring("Method ReadBuffer")] HRESULT ReadBuffer([in] LONGLONG startIndex, [in] LONG numElements, [out, retval] SAFEARRAY (struct TraceMessage) *messages);
#endif
};

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