IWriteContainer.idl

Go to the documentation of this file.

// -----------------------------------------------------------------------
// MLPI - <IWriteContainer.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(DDD6919C-EB62-46d3-B87A-DD6514CFBCC8),
  dual,
  nonextensible,
  helpstring("IWriteContainer Interface"),
  pointer_default(unique)
]
interface IWriteContainer : IDispatch{

  [id(1), helpstring("Method GetName")] HRESULT GetName([out, retval] BSTR* name);

  [id(2), helpstring("Method Update")] HRESULT Update(void);
  
  [id(3), helpstring("Method Destroy")] HRESULT Destroy(void);
  
  [id(4), helpstring("Method Create")] HRESULT Create(void);

#if defined(WIN32) || defined(WIN64)

  [id(5), helpstring("Method GetInformation")] HRESULT GetInformation([out, retval] struct ContainerInformation *containerInformation);
  
  [id(6), helpstring("Method GetItemInformation")] HRESULT GetItemInformation([out, retval] SAFEARRAY (struct ContainerItemInformation) *containerInfo);
#endif

  [id(7), helpstring("Method GetTagList")] HRESULT GetTagList([out, retval] SAFEARRAY(BSTR) *tagList);

  [id(10), helpstring("Method GetDataByTag")] HRESULT GetDataByTag([in] BSTR tag, [out, retval] VARIANT *data);
  
  [id(11), helpstring("Method SetDataByTag")] HRESULT SetDataByTag([in] BSTR tag, [in] VARIANT data);
  
  [id(12), helpstring("Method GetDataAsByteArray")] HRESULT GetDataAsByteArray([out, retval] SAFEARRAY(BYTE) *data);
  
  [id(13), helpstring("Method SetDataAsByteArray")] HRESULT SetDataAsByteArray([in] SAFEARRAY(BYTE) data);

  [id(20), helpstring("Method Add")] HRESULT Add([in] BSTR tag);

  [id(21), helpstring("Method Remove")] HRESULT Remove([in] BSTR tag);

  [id(22), helpstring("Method Clear")] HRESULT Clear();
  
  //[id(3), helpstring("Method Update")] HRESULT Add([in] BSTR sequence);
  //[id(3), helpstring("Method Update")] HRESULT AddSymbol([in] BSTR symbol);
  //[id(3), helpstring("Method Update")] HRESULT AddSymbols([in] BSTR symbol);
  //[id(3), helpstring("Method Update")] HRESULT AddMemoryArea([in] , int byteLength, );
  //[id(3), helpstring("Method Update")] HRESULT AddFieldbusIo([in] BSTR sequence);
  //[id(3), helpstring("Method Update")] HRESULT AddDummy([in] int byteLength);

};



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