Vanilla.PDF  1.4.1
Cross-platform toolkit for creating and modifying PDF documents
c_string_object.h
Go to the documentation of this file.
1 #ifndef _C_STRING_OBJECT_H
2 #define _C_STRING_OBJECT_H
3 
4 #include "vanillapdf/c_export.h"
5 #include "vanillapdf/c_handles.h"
6 #include "vanillapdf/c_values.h"
7 
8 #ifdef __cplusplus
9 extern "C"
10 {
11 #endif
12 
42  typedef enum {
47  StringType_Literal = 0,
48 
53  StringType_Hexadecimal
54  } StringType;
55 
64  VANILLAPDF_API error_type CALLING_CONVENTION StringObject_GetType(StringObjectHandle* handle, StringType* result);
65 
69  VANILLAPDF_API error_type CALLING_CONVENTION StringObject_GetValue(StringObjectHandle* handle, BufferHandle** result);
70 
74  VANILLAPDF_API error_type CALLING_CONVENTION StringObject_SetValue(StringObjectHandle* handle, BufferHandle* value);
75 
79  VANILLAPDF_API error_type CALLING_CONVENTION StringObject_ToObject(StringObjectHandle* handle, ObjectHandle** result);
80 
84  VANILLAPDF_API error_type CALLING_CONVENTION StringObject_FromObject(ObjectHandle* handle, StringObjectHandle** result);
85 
89  VANILLAPDF_API error_type CALLING_CONVENTION StringObject_Release(StringObjectHandle* handle);
90 
101  VANILLAPDF_API error_type CALLING_CONVENTION LiteralStringObject_Create(LiteralStringObjectHandle** result);
102 
106  VANILLAPDF_API error_type CALLING_CONVENTION LiteralStringObject_CreateFromEncodedBuffer(BufferHandle* value, LiteralStringObjectHandle** result);
107 
111  VANILLAPDF_API error_type CALLING_CONVENTION LiteralStringObject_CreateFromEncodedString(string_type value, LiteralStringObjectHandle** result);
112 
116  VANILLAPDF_API error_type CALLING_CONVENTION LiteralStringObject_CreateFromDecodedBuffer(BufferHandle* value, LiteralStringObjectHandle** result);
117 
121  VANILLAPDF_API error_type CALLING_CONVENTION LiteralStringObject_CreateFromDecodedString(string_type value, LiteralStringObjectHandle** result);
122 
126  VANILLAPDF_API error_type CALLING_CONVENTION LiteralStringObject_GetValue(LiteralStringObjectHandle* handle, BufferHandle** result);
127 
131  VANILLAPDF_API error_type CALLING_CONVENTION LiteralStringObject_SetValue(LiteralStringObjectHandle* handle, BufferHandle* value);
132 
136  VANILLAPDF_API error_type CALLING_CONVENTION LiteralStringObject_ToStringObject(LiteralStringObjectHandle* handle, StringObjectHandle** result);
137 
141  VANILLAPDF_API error_type CALLING_CONVENTION LiteralStringObject_FromStringObject(StringObjectHandle* handle, LiteralStringObjectHandle** result);
142 
146  VANILLAPDF_API error_type CALLING_CONVENTION LiteralStringObject_Release(LiteralStringObjectHandle* handle);
147 
158  VANILLAPDF_API error_type CALLING_CONVENTION HexadecimalStringObject_Create(HexadecimalStringObjectHandle** result);
159 
163  VANILLAPDF_API error_type CALLING_CONVENTION HexadecimalStringObject_CreateFromEncodedBuffer(BufferHandle* value, HexadecimalStringObjectHandle** result);
164 
168  VANILLAPDF_API error_type CALLING_CONVENTION HexadecimalStringObject_CreateFromEncodedString(string_type value, HexadecimalStringObjectHandle** result);
169 
173  VANILLAPDF_API error_type CALLING_CONVENTION HexadecimalStringObject_CreateFromDecodedBuffer(BufferHandle* value, HexadecimalStringObjectHandle** result);
174 
178  VANILLAPDF_API error_type CALLING_CONVENTION HexadecimalStringObject_CreateFromDecodedString(string_type value, HexadecimalStringObjectHandle** result);
179 
183  VANILLAPDF_API error_type CALLING_CONVENTION HexadecimalStringObject_GetValue(HexadecimalStringObjectHandle* handle, BufferHandle** result);
184 
188  VANILLAPDF_API error_type CALLING_CONVENTION HexadecimalStringObject_SetValue(HexadecimalStringObjectHandle* handle, BufferHandle* value);
189 
193  VANILLAPDF_API error_type CALLING_CONVENTION HexadecimalStringObject_ToStringObject(HexadecimalStringObjectHandle* handle, StringObjectHandle** result);
194 
198  VANILLAPDF_API error_type CALLING_CONVENTION HexadecimalStringObject_FromStringObject(StringObjectHandle* handle, HexadecimalStringObjectHandle** result);
199 
203  VANILLAPDF_API error_type CALLING_CONVENTION HexadecimalStringObject_Release(HexadecimalStringObjectHandle* handle);
204 
207 #ifdef __cplusplus
208 };
209 #endif
210 
211 #endif /* _C_STRING_OBJECT_H */
StringObjectHandle::StringObject_Release
error_type StringObject_Release(StringObjectHandle *handle)
Decrement the internal reference counter.
HexadecimalStringObjectHandle::HexadecimalStringObject_CreateFromDecodedString
error_type HexadecimalStringObject_CreateFromDecodedString(string_type value, HexadecimalStringObjectHandle **result)
Creates a new HexadecimalStringObject instance from decoded string data.
StringType
StringType
Available types of strings.
Definition: c_string_object.h:42
LiteralStringObjectHandle::LiteralStringObject_CreateFromEncodedBuffer
error_type LiteralStringObject_CreateFromEncodedBuffer(BufferHandle *value, LiteralStringObjectHandle **result)
Creates a new LiteralStringObject instance from encoded data.
LiteralStringObjectHandle
Text stored in raw format.
LiteralStringObjectHandle::LiteralStringObject_Release
error_type LiteralStringObject_Release(LiteralStringObjectHandle *handle)
Decrement the internal reference counter.
StringType_Hexadecimal
Definition: c_string_object.h:53
HexadecimalStringObjectHandle
Text stored in hexadecimal notation.
HexadecimalStringObjectHandle::HexadecimalStringObject_CreateFromDecodedBuffer
error_type HexadecimalStringObject_CreateFromDecodedBuffer(BufferHandle *value, HexadecimalStringObjectHandle **result)
Creates a new HexadecimalStringObject instance from decoded data.
HexadecimalStringObjectHandle::HexadecimalStringObject_SetValue
error_type HexadecimalStringObject_SetValue(HexadecimalStringObjectHandle *handle, BufferHandle *value)
Set strings new value.
StringObjectHandle::StringObject_FromObject
error_type StringObject_FromObject(ObjectHandle *handle, StringObjectHandle **result)
Convert ObjectHandle to StringObjectHandle.
LiteralStringObjectHandle::LiteralStringObject_CreateFromDecodedBuffer
error_type LiteralStringObject_CreateFromDecodedBuffer(BufferHandle *value, LiteralStringObjectHandle **result)
Creates a new LiteralStringObject instance from decoded data.
HexadecimalStringObjectHandle::HexadecimalStringObject_GetValue
error_type HexadecimalStringObject_GetValue(HexadecimalStringObjectHandle *handle, BufferHandle **result)
Get strings current value.
LiteralStringObjectHandle::LiteralStringObject_CreateFromEncodedString
error_type LiteralStringObject_CreateFromEncodedString(string_type value, LiteralStringObjectHandle **result)
Creates a new LiteralStringObject instance from encoded string data.
LiteralStringObjectHandle::LiteralStringObject_GetValue
error_type LiteralStringObject_GetValue(LiteralStringObjectHandle *handle, BufferHandle **result)
Get strings current value.
c_handles.h
This file contains all type forward declarations returned by the library API.
HexadecimalStringObjectHandle::HexadecimalStringObject_ToStringObject
error_type HexadecimalStringObject_ToStringObject(HexadecimalStringObjectHandle *handle, StringObjectHandle **result)
Reinterpret current object as StringObjectHandle.
LiteralStringObjectHandle::LiteralStringObject_SetValue
error_type LiteralStringObject_SetValue(LiteralStringObjectHandle *handle, BufferHandle *value)
Set strings new value.
string_type
const char * string_type
C-Style string.
Definition: c_types.h:82
LiteralStringObjectHandle::LiteralStringObject_FromStringObject
error_type LiteralStringObject_FromStringObject(StringObjectHandle *handle, LiteralStringObjectHandle **result)
Convert IUnknownHandle to LiteralStringObjectHandle.
StringObjectHandle::StringObject_SetValue
error_type StringObject_SetValue(StringObjectHandle *handle, BufferHandle *value)
Set strings new value.
LiteralStringObjectHandle::LiteralStringObject_ToStringObject
error_type LiteralStringObject_ToStringObject(LiteralStringObjectHandle *handle, StringObjectHandle **result)
Reinterpret current object as StringObjectHandle.
ObjectHandle
Base class for syntactic tokens.
StringObjectHandle::StringObject_GetType
error_type StringObject_GetType(StringObjectHandle *handle, StringType *result)
Get derived type from current string.
HexadecimalStringObjectHandle::HexadecimalStringObject_CreateFromEncodedString
error_type HexadecimalStringObject_CreateFromEncodedString(string_type value, HexadecimalStringObjectHandle **result)
Creates a new HexadecimalStringObject instance from encoded string data.
StringType_Literal
Definition: c_string_object.h:47
error_type
uint32_t error_type
This is return value type of all API functions.
Definition: c_types.h:25
c_export.h
This file contains macro declarations for importing and exporting symbols from library boundaries...
LiteralStringObjectHandle::LiteralStringObject_CreateFromDecodedString
error_type LiteralStringObject_CreateFromDecodedString(string_type value, LiteralStringObjectHandle **result)
Creates a new LiteralStringObject instance from decoded string data.
HexadecimalStringObjectHandle::HexadecimalStringObject_Create
error_type HexadecimalStringObject_Create(HexadecimalStringObjectHandle **result)
Creates a new HexadecimalStringObject instance.
LiteralStringObjectHandle::LiteralStringObject_Create
error_type LiteralStringObject_Create(LiteralStringObjectHandle **result)
Creates a new LiteralStringObject instance.
StringObjectHandle::StringObject_ToObject
error_type StringObject_ToObject(StringObjectHandle *handle, ObjectHandle **result)
Reinterpret current object as ObjectHandle.
c_values.h
This file contains types and constants used as parameters or return values.
HexadecimalStringObjectHandle::HexadecimalStringObject_CreateFromEncodedBuffer
error_type HexadecimalStringObject_CreateFromEncodedBuffer(BufferHandle *value, HexadecimalStringObjectHandle **result)
Creates a new HexadecimalStringObject instance from encoded data.
StringObjectHandle
Reprsents human readable text.
BufferHandle
Represents memory stored data.
HexadecimalStringObjectHandle::HexadecimalStringObject_FromStringObject
error_type HexadecimalStringObject_FromStringObject(StringObjectHandle *handle, HexadecimalStringObjectHandle **result)
Convert IUnknownHandle to HexadecimalStringObjectHandle.
HexadecimalStringObjectHandle::HexadecimalStringObject_Release
error_type HexadecimalStringObject_Release(HexadecimalStringObjectHandle *handle)
Decrement the internal reference counter.
StringObjectHandle::StringObject_GetValue
error_type StringObject_GetValue(StringObjectHandle *handle, BufferHandle **result)
Get strings current value.