xref: /AOO41X/main/extensions/test/ole/AxTestComponents/AxTestComponents.idl (revision 757e8756eda6806da8f7860a36dcea9cd985a02d)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23// AxTestComponents.idl : IDL source for AxTestComponents.dll
24//
25
26// This file will be processed by the MIDL tool to
27// produce the type library (AxTestComponents.tlb) and marshalling code.
28// next id 86
29import "oaidl.idl";
30import "ocidl.idl";
31    [
32        object,
33        uuid(BFE10EBD-8584-11D4-8335-005004526AB4),
34        dual,
35        helpstring("IBasic Interface"),
36        pointer_default(unique)
37    ]
38    interface IBasic : IDispatch
39    {
40        [id(82), helpstring("method inBool")] HRESULT inBool([in]VARIANT_BOOL val);
41        [id(1), helpstring("method inByte")] HRESULT inByte([in] unsigned char val);
42        [id(2), helpstring("method inShort")] HRESULT inShort([in] short val);
43        [id(3), helpstring("method inLong")] HRESULT inLong([in] long val);
44        [id(4), helpstring("method inString")] HRESULT inString([in] BSTR val);
45        [id(5), helpstring("method inFloat")] HRESULT inFloat([in] float val);
46        [id(6), helpstring("method inDouble")] HRESULT inDouble([in] double val);
47        [id(7), helpstring("method inVariant")] HRESULT inVariant([in] VARIANT val);
48        [id(8), helpstring("method inArray")] HRESULT inArray([in] SAFEARRAY(VARIANT) val);
49        [id(9), helpstring("method inObject")] HRESULT inObject([in] IDispatch* val);
50        [id(83), helpstring("method inoutBool")] HRESULT inoutBool([in,out]VARIANT_BOOL* val);
51        [id(12), helpstring("method inoutByte")] HRESULT inoutByte([in,out] unsigned char* val);
52        [id(13), helpstring("method inoutShort")] HRESULT inoutShort([in,out] short* val);
53        [id(14), helpstring("method inoutLong")] HRESULT inoutLong([in,out] long * val);
54        [id(15), helpstring("method inoutString")] HRESULT inoutString([in, out] BSTR* val);
55        [id(16), helpstring("method inoutFloat")] HRESULT inoutFloat([in,out] float * val);
56        [id(17), helpstring("method inoutDouble")] HRESULT inoutDouble([in,out] double * val);
57        [id(18), helpstring("method inoutVariant")] HRESULT inoutVariant([in,out] VARIANT * val);
58        [id(19), helpstring("method inoutArray")] HRESULT inoutArray([in,out] SAFEARRAY(VARIANT) * val);
59        [id(20), helpstring("method inoutObject")] HRESULT inoutObject([in,out] IDispatch** val);
60        [id(84), helpstring("method outBool")] HRESULT outBool([out] VARIANT_BOOL* val);
61        [id(23), helpstring("method outByte")] HRESULT outByte([out] unsigned char* val);
62        [id(24), helpstring("method outShort")] HRESULT outShort([out] short* val);
63        [id(25), helpstring("method outLong")] HRESULT outLong([out] long* val);
64        [id(26), helpstring("method outString")] HRESULT outString([out] BSTR* val);
65        [id(27), helpstring("method outFloat")] HRESULT outFloat([out] float* val);
66        [id(28), helpstring("method outDouble")] HRESULT outDouble([out] double* val);
67        [id(29), helpstring("method outVariant")] HRESULT outVariant([out] VARIANT* val);
68        [id(30), helpstring("method outArray")] HRESULT outArray([out] SAFEARRAY(VARIANT) * val);
69        [id(31), helpstring("method outObject")] HRESULT outObject([out] IDispatch** val);
70        [propget, id(85), helpstring("property prpBool")] HRESULT prpBool([out, retval] VARIANT_BOOL *pVal);
71        [propput, id(85), helpstring("property prpBool")] HRESULT prpBool([in] VARIANT_BOOL newVal);
72        [propget, id(34), helpstring("property prpByte")] HRESULT prpByte([out, retval] unsigned char *pVal);
73        [propput, id(34), helpstring("property prpByte")] HRESULT prpByte([in] unsigned char newVal);
74        [propget, id(35), helpstring("property prpShort")] HRESULT prpShort([out, retval] short *pVal);
75        [propput, id(35), helpstring("property prpShort")] HRESULT prpShort([in] short newVal);
76        [propget, id(36), helpstring("property prpLong")] HRESULT prpLong([out, retval] long *pVal);
77        [propput, id(36), helpstring("property prpLong")] HRESULT prpLong([in] long newVal);
78        [propget, id(37), helpstring("property prpString")] HRESULT prpString([out, retval] BSTR *pVal);
79        [propput, id(37), helpstring("property prpString")] HRESULT prpString([in] BSTR newVal);
80        [propget, id(38), helpstring("property prpFloat")] HRESULT prpFloat([out, retval] float *pVal);
81        [propput, id(38), helpstring("property prpFloat")] HRESULT prpFloat([in] float newVal);
82        [propget, id(39), helpstring("property prpDouble")] HRESULT prpDouble([out, retval] double *pVal);
83        [propput, id(39), helpstring("property prpDouble")] HRESULT prpDouble([in] double newVal);
84        [propget, id(40), helpstring("property prpVariant")] HRESULT prpVariant([out, retval] VARIANT *pVal);
85        [propput, id(40), helpstring("property prpVariant")] HRESULT prpVariant([in] VARIANT newVal);
86        [propget, id(41), helpstring("property prpArray")] HRESULT prpArray([out, retval]SAFEARRAY(VARIANT) *pVal);
87        [propput, id(41), helpstring("property prpArray")] HRESULT prpArray([in] SAFEARRAY(VARIANT) newVal);
88        [propget, id(42), helpstring("property prpObject")] HRESULT prpObject([out, retval] IDispatch* *pVal);
89        [propput, id(42), helpstring("property prpObject")] HRESULT prpObject([in] IDispatch* newVal);
90        [id(43), helpstring("method mixed1")] HRESULT mixed1(
91                                              [in, out] unsigned char* aChar,
92                                              [in, out] float *aFloat,
93                                              [in,out] VARIANT* inoutVar);
94        [id(44), helpstring("method inSequenceLong")] HRESULT inSequenceLong([in] SAFEARRAY(long)  ar);
95        [id(45), helpstring("method inSequenceByte")] HRESULT inSequenceByte([in] SAFEARRAY(byte) ar);
96        [id(46), helpstring("method inSequenceShort")] HRESULT inSequenceShort([in] SAFEARRAY(short) ar);
97        [id(47), helpstring("method inSequenceString")] HRESULT inSequenceString([in] SAFEARRAY( BSTR) ar);
98        [id(48), helpstring("method inSequenceFloat")] HRESULT inSequenceFloat([in] SAFEARRAY(float) ar);
99        [id(49), helpstring("method inSequenceDouble")] HRESULT inSequenceDouble([in] SAFEARRAY(double) ar);
100        [id(50), helpstring("method inSequenceObject")] HRESULT inSequenceObject([in] SAFEARRAY(IDispatch*) ar);
101        [id(51), helpstring("method outSequenceByte")] HRESULT outSequenceByte([out] SAFEARRAY(unsigned char)* val);
102        [id(52), helpstring("method outSequenceShort")] HRESULT outSequenceShort([out] SAFEARRAY(short)* val);
103        [id(53), helpstring("method outSequenceLong")] HRESULT outSequenceLong([out] SAFEARRAY(long )*val);
104        [id(54), helpstring("method outSequenceString")] HRESULT outSequenceString([out] SAFEARRAY(BSTR)* val);
105        [id(55), helpstring("method outSequenceFloat")] HRESULT outSequenceFloat([out] SAFEARRAY(float)* val);
106        [id(56), helpstring("method outSequenceDouble")] HRESULT outSequenceDouble([out] SAFEARRAY(double)* val);
107        [id(57), helpstring("method outSequenceObject")] HRESULT outSequenceObject([out] SAFEARRAY(IDispatch*)* val);
108        [id(58), helpstring("method inoutSequenceByte")] HRESULT inoutSequenceByte([in,out] SAFEARRAY(unsigned char)* val);
109        [id(59), helpstring("method inoutSequenceShort")] HRESULT inoutSequenceShort([in,out] SAFEARRAY(short)* val);
110        [id(60), helpstring("method inoutSequenceLong")] HRESULT inoutSequenceLong([in,out] SAFEARRAY( long)*val);
111        [id(61), helpstring("method inoutSequenceString")] HRESULT inoutSequenceString([in,out] SAFEARRAY(BSTR)* val);
112        [id(62), helpstring("method inoutSequenceFloat")] HRESULT inoutSequenceFloat([in,out] SAFEARRAY(float)* val);
113        [id(63), helpstring("method inoutSequenceDouble")] HRESULT inoutSequenceDouble([in,out] SAFEARRAY(double)* val);
114        [id(64), helpstring("method inoutSequenceObject")] HRESULT inoutSequenceObject([in,out] SAFEARRAY(IDispatch*)* val);
115        [id(65), helpstring("method inMulDimArrayLong")] HRESULT inMulDimArrayLong([in] SAFEARRAY(long) val );
116        [id(66), helpstring("method inMulDimArrayVariant")] HRESULT inMulDimArrayVariant([in] SAFEARRAY(VARIANT) val);
117        [id(67), helpstring("method inMulDimArrayLong2")] HRESULT inMulDimArrayLong2([in] SAFEARRAY(long) val);
118        [id(68), helpstring("method inMulDimArrayVariant2")] HRESULT inMulDimArrayVariant2([in] SAFEARRAY(VARIANT) val);
119        [id(69), helpstring("method inMulDimArrayByte")] HRESULT inMulDimArrayByte([in] SAFEARRAY(unsigned char) val);
120        [id(70), helpstring("method inMulDimArrayByte2")] HRESULT inMulDimArrayByte2([in] SAFEARRAY(unsigned char) val);
121        [id(71), helpstring("method outMore")] HRESULT outMore([out]long* val1, [out]long* val2);
122
123        [id(72), helpstring("method optional1")]
124        HRESULT optional1([in] long val1, [in, optional] VARIANT* val2);
125        [id(73), helpstring("method optional2")]
126        HRESULT optional2([out] long* val1, [out, optional] VARIANT* val2);
127        [id(74), helpstring("method optional3")]
128        HRESULT optional3([in, optional] VARIANT* val1, [in, optional] VARIANT* val2);
129        [id(75), helpstring("method optional4")]
130        HRESULT optional4([in, out, optional] VARIANT* val1, [in, out, optional] VARIANT* val2);
131        [id(76), helpstring("method optional5")]
132        HRESULT optional5([out, optional] VARIANT* val1, [out, optional] VARIANT* val2);
133        //midl creates for val4 a BSTR "4" as default value in the TLB. The midl complains
134        //but the error message seems to be not for this case.
135        //in defaultvalue2 val4 has an VT_I4 in the TLB. This must be a bug!
136        [id(77), helpstring("method defaultvalue1")]
137        HRESULT defaultvalue1([in, defaultvalue(1)] long val1,
138                              [in, defaultvalue(2)] double* val2,
139                             // [in, defaultvalue(3)] VARIANT val3, //ok
140                              [in, defaultvalue(4)] VARIANT* val4);
141
142        // bug im midl: when val3 and val4 are pointers then the generated header cretates
143        // for all params default values:
144        //HRESULT STDMETHODCALLTYPE defaultvalue2(
145        //            /* [defaultvalue][in] */ long *val1 = 10,
146        //    /* [defaultvalue][in] */ double *val2 = 3.14,
147        //    /* [defaultvalue][in] */ VARIANT *val3 = 10,
148        //    /* [defaultvalue][in] */ VARIANT *val4 = 100) = 0;
149        // And that does not compile.
150        //Therefore we must not include the midl generated header, instead use
151        // #import to create the interface header
152        [id(78), helpstring("method defaultvalue2")]
153        HRESULT defaultvalue2([in, out, defaultvalue(1)]long* val1,
154                              [in, out, defaultvalue(2)] double* val2,
155                             // [in, out, defaultvalue(3)] VARIANT *val3,
156                              [in, out, defaultvalue(4)] VARIANT *val4);
157
158        [id(79), helpstring("method varargfunc1"),vararg]
159        HRESULT varargfunc1([in] long val1, [in] SAFEARRAY(VARIANT) val2);
160        [id(80), helpstring("method varargfunc2")]
161        HRESULT varargfunc2([out] long* val1, [out] SAFEARRAY(VARIANT)* val2);
162
163
164        [id(86), helpstring("method inSequenceByteDim2")] HRESULT inSequenceByteDim2([in] SAFEARRAY(byte) val);
165        [id(87), helpstring("method inCurrency")] HRESULT inCurrency([in] CY val);
166        [id(88), helpstring("method outCurrency")] HRESULT outCurrency([out] CY* val);
167        [id(89), helpstring("method inoutCurrency")] HRESULT inoutCurrency([in,out] CY* val);
168        [id(90), helpstring("method inDate")] HRESULT inDate([in] DATE val);
169        [id(91), helpstring("method outDate")] HRESULT outDate([out] DATE* val);
170        [id(92), helpstring("method inoutDate")] HRESULT inoutDate([in,out] DATE* val);
171        [propget, id(93), helpstring("property prpCY")] HRESULT prpCurrency([out, retval] CY* pVal);
172        [propput, id(93), helpstring("property prpCY")] HRESULT prpCurrency([in] CY newVal);
173        [propget, id(94), helpstring("property prpDate")] HRESULT prpDate([out, retval] DATE* pVal);
174        [propput, id(94), helpstring("property prpDate")] HRESULT prpDate([in] DATE newVal);
175        [id(95), helpstring("method inDecimal")] HRESULT inDecimal([in] DECIMAL val);
176        [id(96), helpstring("method outDecimal")] HRESULT outDecimal([out] DECIMAL* val);
177        [id(97), helpstring("method inoutDecimal")] HRESULT inoutDecimal([in,out] DECIMAL* val);
178        [propget, id(98), helpstring("property prpDecimal")] HRESULT prpDecimal([out, retval] DECIMAL* pVal);
179        [propput, id(98), helpstring("property prpDecimal")] HRESULT prpDecimal([in] DECIMAL newVal);
180        [id(99), helpstring("method inSCode")] HRESULT inSCode([in] SCODE val);
181        [id(100), helpstring("method outScode")] HRESULT outScode([out] SCODE* val);
182        [id(101), helpstring("method inoutSCode")] HRESULT inoutSCode([in,out] SCODE* val);
183        [propget, id(102), helpstring("property prpSCode")] HRESULT prpSCode([out, retval] SCODE* pVal);
184        [propput, id(102), helpstring("property prpSCode")] HRESULT prpSCode([in] SCODE newVal);
185        [id(103), helpstring("method inrefLong")] HRESULT inrefLong([in] LONG* val);
186        [id(104), helpstring("method inrefVARIANT")] HRESULT inrefVariant([in] VARIANT* val);
187        [id(105), helpstring("method inrefDecimal")] HRESULT inrefDecimal(DECIMAL* val);
188        [propget, id(106), helpstring("property prpRefLong")] HRESULT prpRefLong([out, retval] long* pVal);
189        [propputref, id(106), helpstring("property prpRefLong")] HRESULT prpRefLong([in] long* newVal);
190        [propget, id(107), helpstring("property prprefVariant")] HRESULT prprefVariant([out, retval] VARIANT* pVal);
191        [propputref, id(107), helpstring("property prprefVariant")] HRESULT prprefVariant([in] VARIANT* newVal);
192        [propget, id(108), helpstring("property prprefDecimal")] HRESULT prprefDecimal([out, retval] DECIMAL* pVal);
193        [propputref, id(108), helpstring("property prprefDecimal")] HRESULT prprefDecimal([in] DECIMAL* newVal);
194        [id(109), helpstring("method optional6")] HRESULT optional6([in,optional] VARIANT* val1,
195            [in,optional] VARIANT * val2, [in,optional] VARIANT* val3, [in,optional] VARIANT* val4);
196        [id(110), helpstring("method optional7")] HRESULT optional7([out,optional] VARIANT* val1,
197            [out,optional] VARIANT * val2, [out,optional] VARIANT* val3, [out,optional] VARIANT* val4);
198
199        [propget, id(111), helpstring("property prpMultiArg1")] HRESULT prpMultiArg1([in,out,optional] VARIANT* val1, [in,out,optional] VARIANT* val2, [out, optional, retval] VARIANT* pVal);
200        [propput, id(111), helpstring("property prpMultiArg1")] HRESULT prpMultiArg1([in,out,optional] VARIANT* val1, [in,out,optional] VARIANT* val2, [in] VARIANT* newVal);
201        [propget, id(112), helpstring("property prpMultiArg2")] HRESULT prpMultiArg2([in] VARIANT val1, [out, retval] VARIANT* pVal);
202        [propput, id(112), helpstring("property prpMultiArg2")] HRESULT prpMultiArg2([in] VARIANT val1, [in] VARIANT newVal);
203        [id(113), helpstring("method prpMultiArg2GetValues")] HRESULT prpMultiArg2GetValues([out] VARIANT* val1, [out] VARIANT* valProperty);
204        [propget, id(114), helpstring("property prpMultiArg3")] HRESULT prpMultiArg3([in,out] LONG* val1, [out, retval] LONG* pVal);
205        [propput, id(114), helpstring("property prpMultiArg3")] HRESULT prpMultiArg3([in,out] LONG* val1, [in] LONG newVal);
206        [id(115), helpstring("method inUnknown")] HRESULT inUnknown([in] IUnknown* val);
207        [id(116), helpstring("method outUnknown")] HRESULT outUnknown([out] IUnknown** val);
208        [id(117), helpstring("method inoutUnknown")] HRESULT inoutUnknown([in,out] IUnknown** val);
209        [propget, id(118), helpstring("property prpUnknown")] HRESULT prpUnknown([out, retval] IUnknown** pVal);
210        [propput, id(118), helpstring("property prpUnknown")] HRESULT prpUnknown([in] IUnknown* newVal);
211};
212
213[
214    object,
215    uuid(96E6105A-A436-48b3-BFE7-C9302D927CCF),
216    dual,
217    helpstring("IFoo Interface"),
218    pointer_default(unique)
219]
220interface IFoo : IUnknown
221{
222    HRESULT Foo([in] IUnknown* val);
223};
224
225[
226    uuid(BFE10EB1-8584-11D4-8335-005004526AB4),
227    version(1.0),
228    helpstring("AxTestComponents 1.0 Type Library")
229]
230library AXTESTCOMPONENTSLib
231{
232    importlib("stdole32.tlb");
233    importlib("stdole2.tlb");
234
235    [
236        uuid(BFE10EBE-8584-11D4-8335-005004526AB4),
237        helpstring("Basic Class")
238    ]
239    coclass Basic
240    {
241        [default] interface IBasic;
242    };
243
244    [
245        uuid(14DE9D5D-EB9D-4091-8E1B-A1B1672D8C1D),
246        helpstring("Foo Class")
247    ]
248    coclass Foo
249    {
250        [default] interface IFoo;
251    };
252
253};
254