Vanilla.PDF  1.6.0
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
7
8#ifdef __cplusplus
9extern "C"
10{
11#endif
12
42 typedef enum {
43
48
54
61
70 VANILLAPDF_API error_type CALLING_CONVENTION StringObject_GetStringType(StringObjectHandle* handle, StringType* result);
71
75 VANILLAPDF_API error_type CALLING_CONVENTION StringObject_GetValue(StringObjectHandle* handle, BufferHandle** result);
76
80 VANILLAPDF_API error_type CALLING_CONVENTION StringObject_SetValue(StringObjectHandle* handle, BufferHandle* value);
81
85 VANILLAPDF_API error_type CALLING_CONVENTION StringObject_ToObject(StringObjectHandle* handle, ObjectHandle** result);
86
90 VANILLAPDF_API error_type CALLING_CONVENTION StringObject_FromObject(ObjectHandle* handle, StringObjectHandle** result);
91
95 VANILLAPDF_API error_type CALLING_CONVENTION StringObject_Release(StringObjectHandle* handle);
96
107 VANILLAPDF_API error_type CALLING_CONVENTION LiteralStringObject_Create(LiteralStringObjectHandle** result);
108
113
118
123
128
132 VANILLAPDF_API error_type CALLING_CONVENTION LiteralStringObject_GetValue(LiteralStringObjectHandle* handle, BufferHandle** result);
133
137 VANILLAPDF_API error_type CALLING_CONVENTION LiteralStringObject_SetValue(LiteralStringObjectHandle* handle, BufferHandle* value);
138
143
148
152 VANILLAPDF_API error_type CALLING_CONVENTION LiteralStringObject_Release(LiteralStringObjectHandle* handle);
153
165
170
175
180
185
189 VANILLAPDF_API error_type CALLING_CONVENTION HexadecimalStringObject_GetValue(HexadecimalStringObjectHandle* handle, BufferHandle** result);
190
195
200
205
210
213#ifdef __cplusplus
214};
215#endif
216
217#endif /* _C_STRING_OBJECT_H */
This file contains macro declarations for importing and exporting symbols from library boundaries.
This file contains all type forward declarations returned by the library API.
StringType
Derived types of StringObjectHandle.
Definition: c_string_object.h:42
@ StringType_Hexadecimal
A hexadecimal string is preferable for arbitrary binary data.
Definition: c_string_object.h:59
@ StringType_Literal
A literal string is preferable for printable data.
Definition: c_string_object.h:53
@ StringType_Undefined
Undefined unitialized default value, triggers error when used.
Definition: c_string_object.h:47
This file contains types and constants used as parameters or return values.
Represents memory stored data.
A hexadecimal string is preferable for arbitrary binary data.
error_type CALLING_CONVENTION HexadecimalStringObject_FromStringObject(StringObjectHandle *handle, HexadecimalStringObjectHandle **result)
Convert IUnknownHandle to HexadecimalStringObjectHandle.
error_type CALLING_CONVENTION HexadecimalStringObject_Release(HexadecimalStringObjectHandle *handle)
Decrement the internal reference counter.
error_type CALLING_CONVENTION HexadecimalStringObject_SetValue(HexadecimalStringObjectHandle *handle, BufferHandle *value)
Set strings new value.
error_type CALLING_CONVENTION HexadecimalStringObject_ToStringObject(HexadecimalStringObjectHandle *handle, StringObjectHandle **result)
Reinterpret current object as StringObjectHandle.
error_type CALLING_CONVENTION HexadecimalStringObject_CreateFromDecodedBuffer(BufferHandle *value, HexadecimalStringObjectHandle **result)
Creates a new HexadecimalStringObject instance from decoded data.
error_type CALLING_CONVENTION HexadecimalStringObject_CreateFromEncodedString(string_type value, HexadecimalStringObjectHandle **result)
Creates a new HexadecimalStringObject instance from encoded string data.
error_type CALLING_CONVENTION HexadecimalStringObject_GetValue(HexadecimalStringObjectHandle *handle, BufferHandle **result)
Get strings current value.
error_type CALLING_CONVENTION HexadecimalStringObject_CreateFromEncodedBuffer(BufferHandle *value, HexadecimalStringObjectHandle **result)
Creates a new HexadecimalStringObject instance from encoded data.
error_type CALLING_CONVENTION HexadecimalStringObject_Create(HexadecimalStringObjectHandle **result)
Creates a new HexadecimalStringObject instance.
error_type CALLING_CONVENTION HexadecimalStringObject_CreateFromDecodedString(string_type value, HexadecimalStringObjectHandle **result)
Creates a new HexadecimalStringObject instance from decoded string data.
A literal string is preferable for printable data.
error_type CALLING_CONVENTION LiteralStringObject_ToStringObject(LiteralStringObjectHandle *handle, StringObjectHandle **result)
Reinterpret current object as StringObjectHandle.
error_type CALLING_CONVENTION LiteralStringObject_Create(LiteralStringObjectHandle **result)
Creates a new LiteralStringObjectHandle instance.
error_type CALLING_CONVENTION LiteralStringObject_FromStringObject(StringObjectHandle *handle, LiteralStringObjectHandle **result)
Convert IUnknownHandle to LiteralStringObjectHandle.
error_type CALLING_CONVENTION LiteralStringObject_CreateFromEncodedString(string_type value, LiteralStringObjectHandle **result)
Creates a new LiteralStringObjectHandle instance from PDF encoded string data.
error_type CALLING_CONVENTION LiteralStringObject_CreateFromDecodedBuffer(BufferHandle *value, LiteralStringObjectHandle **result)
Creates a new LiteralStringObjectHandle instance from decoded data without PDF syntax.
error_type CALLING_CONVENTION LiteralStringObject_Release(LiteralStringObjectHandle *handle)
Decrement the internal reference counter.
error_type CALLING_CONVENTION LiteralStringObject_CreateFromDecodedString(string_type value, LiteralStringObjectHandle **result)
Creates a new LiteralStringObjectHandle instance from decoded string data without PDF syntax.
error_type CALLING_CONVENTION LiteralStringObject_SetValue(LiteralStringObjectHandle *handle, BufferHandle *value)
Set strings new value.
error_type CALLING_CONVENTION LiteralStringObject_CreateFromEncodedBuffer(BufferHandle *value, LiteralStringObjectHandle **result)
Creates a new LiteralStringObjectHandle instance from PDF encoded data.
error_type CALLING_CONVENTION LiteralStringObject_GetValue(LiteralStringObjectHandle *handle, BufferHandle **result)
Get strings current value.
Base class for syntactic tokens.
Reprsents human readable text.
error_type CALLING_CONVENTION StringObject_SetValue(StringObjectHandle *handle, BufferHandle *value)
Set strings new value.
error_type CALLING_CONVENTION StringObject_GetStringType(StringObjectHandle *handle, StringType *result)
Get derived type from current string.
error_type CALLING_CONVENTION StringObject_FromObject(ObjectHandle *handle, StringObjectHandle **result)
Convert ObjectHandle to StringObjectHandle.
error_type CALLING_CONVENTION StringObject_GetValue(StringObjectHandle *handle, BufferHandle **result)
Get strings current value.
error_type CALLING_CONVENTION StringObject_ToObject(StringObjectHandle *handle, ObjectHandle **result)
Reinterpret current object as ObjectHandle.
error_type CALLING_CONVENTION StringObject_Release(StringObjectHandle *handle)
Decrement the internal reference counter.
uint32_t error_type
This is return value type of all API functions.
Definition: c_types.h:25
const char * string_type
C-Style string.
Definition: c_types.h:82