writer.h (86e1cf34) writer.h (f006f9b4)
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

--- 12 unchanged lines hidden (view full) ---

21
22
23
24#ifndef INCLUDED_registry_writer_h
25#define INCLUDED_registry_writer_h
26
27#include "registry/types.h"
28#include "registry/version.h"
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

--- 12 unchanged lines hidden (view full) ---

21
22
23
24#ifndef INCLUDED_registry_writer_h
25#define INCLUDED_registry_writer_h
26
27#include "registry/types.h"
28#include "registry/version.h"
29#include "registry/registrydllapi.h"
29
30#include "rtl/ustring.h"
31#include "sal/types.h"
32
33#ifdef __cplusplus
34extern "C" {
35#endif
36

--- 25 unchanged lines hidden (view full) ---

62
63 @param referenceCount the number of references of the created type writer
64
65 @return a handle on the type writer; if an out-of-memory condition occurs,
66 null is returned, and no type writer is created
67
68 @since UDK 3.2.0
69 */
30
31#include "rtl/ustring.h"
32#include "sal/types.h"
33
34#ifdef __cplusplus
35extern "C" {
36#endif
37

--- 25 unchanged lines hidden (view full) ---

63
64 @param referenceCount the number of references of the created type writer
65
66 @return a handle on the type writer; if an out-of-memory condition occurs,
67 null is returned, and no type writer is created
68
69 @since UDK 3.2.0
70 */
70void * SAL_CALL typereg_writer_create(
71REGISTRY_DLLPUBLIC void * SAL_CALL typereg_writer_create(
71 typereg_Version version, rtl_uString const * documentation,
72 rtl_uString const * fileName, RTTypeClass typeClass, sal_Bool published,
73 rtl_uString const * typeName, sal_uInt16 superTypeCount,
74 sal_uInt16 fieldCount, sal_uInt16 methodCount, sal_uInt16 referenceCount)
75 SAL_THROW_EXTERN_C();
76
77/**
78 Destroys a type writer.
79
80 @param handle a handle on a type writer obtained from a call to
81 <code>typereg_writer_create</code>; must not be null
82
83 @since UDK 3.2.0
84 */
72 typereg_Version version, rtl_uString const * documentation,
73 rtl_uString const * fileName, RTTypeClass typeClass, sal_Bool published,
74 rtl_uString const * typeName, sal_uInt16 superTypeCount,
75 sal_uInt16 fieldCount, sal_uInt16 methodCount, sal_uInt16 referenceCount)
76 SAL_THROW_EXTERN_C();
77
78/**
79 Destroys a type writer.
80
81 @param handle a handle on a type writer obtained from a call to
82 <code>typereg_writer_create</code>; must not be null
83
84 @since UDK 3.2.0
85 */
85void SAL_CALL typereg_writer_destroy(void * handle) SAL_THROW_EXTERN_C();
86REGISTRY_DLLPUBLIC void SAL_CALL typereg_writer_destroy(void * handle) SAL_THROW_EXTERN_C();
86
87/**
88 Sets the type name of a super type of a type writer.
89
90 @param handle a handle on a type writer; must not be null
91
92 @param index a valid index into the range of super types of the given type
93 writer
94
95 @param typeName the super type name; must not be null
96
97 @return false iff an out-of-memory condition occurred, in which case the type
98 writer is not modified
99
100 @since UDK 3.2.0
101 */
87
88/**
89 Sets the type name of a super type of a type writer.
90
91 @param handle a handle on a type writer; must not be null
92
93 @param index a valid index into the range of super types of the given type
94 writer
95
96 @param typeName the super type name; must not be null
97
98 @return false iff an out-of-memory condition occurred, in which case the type
99 writer is not modified
100
101 @since UDK 3.2.0
102 */
102sal_Bool SAL_CALL typereg_writer_setSuperTypeName(
103REGISTRY_DLLPUBLIC sal_Bool SAL_CALL typereg_writer_setSuperTypeName(
103 void * handle, sal_uInt16 index, rtl_uString const * typeName)
104 SAL_THROW_EXTERN_C();
105
106/**
107 Sets the data of a field of a type writer.
108
109 @param handle a handle on a type writer; must not be null
110

--- 13 unchanged lines hidden (view full) ---

124
125 @param valueValue the value of the value of the field
126
127 @return false iff an out-of-memory condition occurred, in which case the type
128 writer is not modified
129
130 @since UDK 3.2.0
131 */
104 void * handle, sal_uInt16 index, rtl_uString const * typeName)
105 SAL_THROW_EXTERN_C();
106
107/**
108 Sets the data of a field of a type writer.
109
110 @param handle a handle on a type writer; must not be null
111

--- 13 unchanged lines hidden (view full) ---

125
126 @param valueValue the value of the value of the field
127
128 @return false iff an out-of-memory condition occurred, in which case the type
129 writer is not modified
130
131 @since UDK 3.2.0
132 */
132sal_Bool SAL_CALL typereg_writer_setFieldData(
133REGISTRY_DLLPUBLIC sal_Bool SAL_CALL typereg_writer_setFieldData(
133 void * handle, sal_uInt16 index, rtl_uString const * documentation,
134 rtl_uString const * fileName, RTFieldAccess flags, rtl_uString const * name,
135 rtl_uString const * typeName, RTValueType valueType,
136 RTConstValueUnion valueValue)
137 SAL_THROW_EXTERN_C();
138
139/**
140 Sets the data of a method of a type writer.

--- 14 unchanged lines hidden (view full) ---

155
156 @param exceptionCount the number of exceptions of the method
157
158 @return false iff an out-of-memory condition occurred, in which case the type
159 writer is not modified
160
161 @since UDK 3.2.0
162 */
134 void * handle, sal_uInt16 index, rtl_uString const * documentation,
135 rtl_uString const * fileName, RTFieldAccess flags, rtl_uString const * name,
136 rtl_uString const * typeName, RTValueType valueType,
137 RTConstValueUnion valueValue)
138 SAL_THROW_EXTERN_C();
139
140/**
141 Sets the data of a method of a type writer.

--- 14 unchanged lines hidden (view full) ---

156
157 @param exceptionCount the number of exceptions of the method
158
159 @return false iff an out-of-memory condition occurred, in which case the type
160 writer is not modified
161
162 @since UDK 3.2.0
163 */
163sal_Bool SAL_CALL typereg_writer_setMethodData(
164REGISTRY_DLLPUBLIC sal_Bool SAL_CALL typereg_writer_setMethodData(
164 void * handle, sal_uInt16 index, rtl_uString const * documentation,
165 RTMethodMode flags, rtl_uString const * name,
166 rtl_uString const * returnTypeName, sal_uInt16 parameterCount,
167 sal_uInt16 exceptionCount)
168 SAL_THROW_EXTERN_C();
169
170/**
171 Sets the data of a parameter of a method of a type writer.

--- 12 unchanged lines hidden (view full) ---

184
185 @param typeName the type name of the parameter; must not be null
186
187 @return false iff an out-of-memory condition occurred, in which case the type
188 writer is not modified
189
190 @since UDK 3.2.0
191 */
165 void * handle, sal_uInt16 index, rtl_uString const * documentation,
166 RTMethodMode flags, rtl_uString const * name,
167 rtl_uString const * returnTypeName, sal_uInt16 parameterCount,
168 sal_uInt16 exceptionCount)
169 SAL_THROW_EXTERN_C();
170
171/**
172 Sets the data of a parameter of a method of a type writer.

--- 12 unchanged lines hidden (view full) ---

185
186 @param typeName the type name of the parameter; must not be null
187
188 @return false iff an out-of-memory condition occurred, in which case the type
189 writer is not modified
190
191 @since UDK 3.2.0
192 */
192sal_Bool SAL_CALL typereg_writer_setMethodParameterData(
193REGISTRY_DLLPUBLIC sal_Bool SAL_CALL typereg_writer_setMethodParameterData(
193 void * handle, sal_uInt16 methodIndex, sal_uInt16 parameterIndex,
194 RTParamMode flags, rtl_uString const * name, rtl_uString const * typeName)
195 SAL_THROW_EXTERN_C();
196
197/**
198 Sets an exception type name of a method of a type writer.
199
200 @param handle a handle on a type writer; must not be null

--- 6 unchanged lines hidden (view full) ---

207
208 @param typeName the exception type name; must not be null
209
210 @return false iff an out-of-memory condition occurred, in which case the type
211 writer is not modified
212
213 @since UDK 3.2.0
214 */
194 void * handle, sal_uInt16 methodIndex, sal_uInt16 parameterIndex,
195 RTParamMode flags, rtl_uString const * name, rtl_uString const * typeName)
196 SAL_THROW_EXTERN_C();
197
198/**
199 Sets an exception type name of a method of a type writer.
200
201 @param handle a handle on a type writer; must not be null

--- 6 unchanged lines hidden (view full) ---

208
209 @param typeName the exception type name; must not be null
210
211 @return false iff an out-of-memory condition occurred, in which case the type
212 writer is not modified
213
214 @since UDK 3.2.0
215 */
215sal_Bool SAL_CALL typereg_writer_setMethodExceptionTypeName(
216REGISTRY_DLLPUBLIC sal_Bool SAL_CALL typereg_writer_setMethodExceptionTypeName(
216 void * handle, sal_uInt16 methodIndex, sal_uInt16 exceptionIndex,
217 rtl_uString const * typeName)
218 SAL_THROW_EXTERN_C();
219
220/**
221 Sets the data of a reference of a type writer.
222
223 @param handle a handle on a type writer; must not be null

--- 9 unchanged lines hidden (view full) ---

233
234 @param typeName the type name of the reference; must not be null
235
236 @return false iff an out-of-memory condition occurred, in which case the type
237 writer is not modified
238
239 @since UDK 3.2.0
240 */
217 void * handle, sal_uInt16 methodIndex, sal_uInt16 exceptionIndex,
218 rtl_uString const * typeName)
219 SAL_THROW_EXTERN_C();
220
221/**
222 Sets the data of a reference of a type writer.
223
224 @param handle a handle on a type writer; must not be null

--- 9 unchanged lines hidden (view full) ---

234
235 @param typeName the type name of the reference; must not be null
236
237 @return false iff an out-of-memory condition occurred, in which case the type
238 writer is not modified
239
240 @since UDK 3.2.0
241 */
241sal_Bool SAL_CALL typereg_writer_setReferenceData(
242REGISTRY_DLLPUBLIC sal_Bool SAL_CALL typereg_writer_setReferenceData(
242 void * handle, sal_uInt16 index, rtl_uString const * documentation,
243 RTReferenceType sort, RTFieldAccess flags, rtl_uString const * typeName)
244 SAL_THROW_EXTERN_C();
245
246/**
247 Returns the blob of a type writer.
248
249 @param handle a handle on a type writer; must not be null
250
251 @param size an out-parameter obtaining the size of the blob; must not be null
252
253 @return a (byte-aligned) pointer to the blob; the returned pointer and the
254 returned <code>size</code> remain valid until the next function is called on
255 the given type writer; if an out-of-memory condition occurs, null is returned
256 and <code>size</code> is not modified
257 */
243 void * handle, sal_uInt16 index, rtl_uString const * documentation,
244 RTReferenceType sort, RTFieldAccess flags, rtl_uString const * typeName)
245 SAL_THROW_EXTERN_C();
246
247/**
248 Returns the blob of a type writer.
249
250 @param handle a handle on a type writer; must not be null
251
252 @param size an out-parameter obtaining the size of the blob; must not be null
253
254 @return a (byte-aligned) pointer to the blob; the returned pointer and the
255 returned <code>size</code> remain valid until the next function is called on
256 the given type writer; if an out-of-memory condition occurs, null is returned
257 and <code>size</code> is not modified
258 */
258void const * SAL_CALL typereg_writer_getBlob(void * handle, sal_uInt32 * size)
259REGISTRY_DLLPUBLIC void const * SAL_CALL typereg_writer_getBlob(void * handle, sal_uInt32 * size)
259 SAL_THROW_EXTERN_C();
260
261#ifdef __cplusplus
262}
263#endif
264
265#endif
260 SAL_THROW_EXTERN_C();
261
262#ifdef __cplusplus
263}
264#endif
265
266#endif