Open Core Interface - MLPI
MLPI-MotionLogicProgrammingInterface(mlpi4COM)  1.26.2
IContainer.idl
Go to the documentation of this file.
1 // -----------------------------------------------------------------------
2 // MLPI - <IContainer.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 
67 [
68  object,
69  uuid(A023FCB0-BCBE-4d86-B8D8-B36174661164),
70  dual,
71  nonextensible,
72  helpstring("IContainer Interface"),
73  pointer_default(unique)
74 ]
75 interface IContainer : IDispatch{
76 
77 
80  typedef [v1_enum] enum ContainerAccess
81  {
85 
86 #if defined(WIN32) || defined(WIN64)
100  {
101  BSTR name;
102  struct DateAndTime dateTime;
103  LONG numItems;
105  LONG dataSize;
107  };
108 
109 
110  [
111  uuid(388F8A5A-9503-4a43-AC34-47E2F24B775A)
112  ]
123  {
124  Type type;
125  LONG offset;
126  LONG dataSize;
127  };
128 #endif
129 
130 
153  [propget, id(1), helpstring("Property Read")] HRESULT Read([out, retval] IReadContainers** readContainer);
154 
177  [propget, id(2), helpstring("Property Write")] HRESULT Write([out, retval] IWriteContainers** writeContainer);
178 
179 };
180 
181 
182 // -----------------------------------------------------------------------
183 // HISTORY
184 // -----------------------------------------------------------------------
185 // 01-Jan-2012
186 // - first release
187 //
188 
189 
190 
191 
192 
193 
LONG numElementsTagList
Number of elements describing container.
Definition: IContainer.idl:104
Definition of the IContainer interface which can be used to establish a fast data exchange of grouped...
Definition: IContainer.idl:75
LONG dataSize
Total data size (byte) of container.
Definition: IContainer.idl:105
IReadContainers Read
This property returns a IReadContainers object which allows access to different IReadContainer object...
Definition of the IReadContainers interface which is a collection of IReadContainer objects...
ContainerAccess
This enumeration defines whether we have a READ or WRITE container.
Definition: IContainer.idl:80
ContainerAccess accessFlag
READ or WRITE access to the container.
Definition: IContainer.idl:106
Enumeration for write container.
Definition: IContainer.idl:83
LONG dataSize
Size of item in bytes.
Definition: IContainer.idl:126
This structure defines the information of a container item.
Definition: IContainer.idl:122
Definition of the IWriteContainers interface which is a collection of IWriteContainer objects...
Enumeration for read container.
Definition: IContainer.idl:82
Type type
Mlpi data type of item.
Definition: IContainer.idl:124
IWriteContainers Write
This property returns a IWriteContainers object which allows access to different IWriteContainer obje...
LONG offset
Offset of item within the container in bytes.
Definition: IContainer.idl:125
BSTR name
Name of container.
Definition: IContainer.idl:101
struct DateAndTime dateTime
Date and time container was created.
Definition: IContainer.idl:102
LONG numItems
Number of entries of container.
Definition: IContainer.idl:103
This structure defines the information content of a container.
Definition: IContainer.idl:99