IParameter.idl

Go to the documentation of this file.

// -----------------------------------------------------------------------
// MLPI - <IParameter.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(E60A1F2E-4D4D-4280-B21C-08C62CA50E96),
  dual,
  nonextensible,
  helpstring("IParameter-Schnittstelle"),
  pointer_default(unique)
]
interface IParameter : IDispatch{


  struct ParameterListLength
  {
    LONG numActualElements;
    LONG numMaximumElements;
    LONG elementSizeBytes;
  };


  [id(1), helpstring("Method ReadData")] HRESULT ReadData([in] BSTR idn, [in, optional] VARIANT address, [in, optional] VARIANT set, [in, optional] VARIANT block, [in, optional] VARIANT si, [in, optional] VARIANT se, [out, retval] VARIANT* data);


  [id(2), helpstring("Method ReadMinimum")] HRESULT ReadMinimum([in] BSTR idn, [in, optional] VARIANT address, [in, optional] VARIANT set, [in, optional] VARIANT block, [in, optional] VARIANT si, [in, optional] VARIANT se, [out, retval] VARIANT* data);


  [id(3), helpstring("Method ReadMaximum")] HRESULT ReadMaximum([in] BSTR idn, [in, optional] VARIANT address, [in, optional] VARIANT set, [in, optional] VARIANT block, [in, optional] VARIANT si, [in, optional] VARIANT se, [out, retval] VARIANT* data);


  [id(4), helpstring("Method ReadDefault")] HRESULT ReadDefault([in] BSTR idn, [in, optional] VARIANT address, [in, optional] VARIANT set, [in, optional] VARIANT block, [in, optional] VARIANT si, [in, optional] VARIANT se, [out, retval] VARIANT* data);


  [id(5), helpstring("Method ReadName")] HRESULT ReadName([in] BSTR idn, [in, optional] VARIANT address, [in, optional] VARIANT set, [in, optional] VARIANT block, [in, optional] VARIANT si, [in, optional] VARIANT se, [out, retval] BSTR* data);


  [id(6), helpstring("Method ReadUnit")] HRESULT ReadUnit([in] BSTR idn, [in, optional] VARIANT address, [in, optional] VARIANT set, [in, optional] VARIANT block, [in, optional] VARIANT si, [in, optional] VARIANT se, [out, retval] BSTR* data);


  [id(7), helpstring("Method ReadDataStatus")] HRESULT ReadDataStatus([in] BSTR idn, [in, optional] VARIANT address, [in, optional] VARIANT set, [in, optional] VARIANT block, [in, optional] VARIANT si, [in, optional] VARIANT se, [out, retval] VARIANT_BOOL* data);


  [id(8), helpstring("Method ReadAttribute")] HRESULT ReadAttribute([in] BSTR idn, [in, optional] VARIANT address, [in, optional] VARIANT set, [in, optional] VARIANT block, [in, optional] VARIANT si, [in, optional] VARIANT se, [out, retval] VARIANT* data);


  [id(9), helpstring("Method Command")] HRESULT Command([in] BSTR idn, [in, optional] VARIANT address, [in, optional] VARIANT set, [in, optional] VARIANT block, [in, optional] VARIANT si, [in, optional] VARIANT se);



  [id(10), helpstring("Method Write")] HRESULT WriteData([in] VARIANT data, [in] BSTR idn, [in, optional] VARIANT address, [in, optional] VARIANT set, [in, optional] VARIANT block, [in, optional] VARIANT si, [in, optional] VARIANT se);

  [id(11), helpstring("Method ReadListLength")] HRESULT ReadListLength([in] BSTR idn, [in, optional] VARIANT address, [in, optional] VARIANT set, [in, optional] VARIANT block, [in, optional] VARIANT si, [in, optional] VARIANT se, [out, retval] struct ParameterListLength *listLength);


  [id(13), helpstring("Method ReadDataAsString")] HRESULT ReadDataAsString([in] BSTR idn, [in, optional] VARIANT address, [in, optional] VARIANT set, [in, optional] VARIANT block, [in, optional] VARIANT si, [in, optional] VARIANT se, [out, retval] BSTR* data);

};



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