Vanilla.PDF  1.3.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 
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_Type(StringObjectHandle* handle, StringType* result);
65 
69  VANILLAPDF_API error_type CALLING_CONVENTION StringObject_ToLiteral(StringObjectHandle* handle, LiteralStringObjectHandle** result);
70 
74  VANILLAPDF_API error_type CALLING_CONVENTION StringObject_ToHexadecimal(StringObjectHandle* handle, HexadecimalStringObjectHandle** result);
75 
79  VANILLAPDF_API error_type CALLING_CONVENTION StringObject_GetValue(StringObjectHandle* handle, BufferHandle** result);
80 
84  VANILLAPDF_API error_type CALLING_CONVENTION StringObject_SetValue(StringObjectHandle* handle, BufferHandle* value);
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_GetValue(LiteralStringObjectHandle* handle, BufferHandle** result);
107 
111  VANILLAPDF_API error_type CALLING_CONVENTION LiteralStringObject_SetValue(LiteralStringObjectHandle* handle, BufferHandle* value);
112 
116  VANILLAPDF_API error_type CALLING_CONVENTION LiteralStringObject_Release(LiteralStringObjectHandle* handle);
117 
128  VANILLAPDF_API error_type CALLING_CONVENTION HexadecimalStringObject_Create(HexadecimalStringObjectHandle** result);
129 
133  VANILLAPDF_API error_type CALLING_CONVENTION HexadecimalStringObject_GetValue(HexadecimalStringObjectHandle* handle, BufferHandle** result);
134 
138  VANILLAPDF_API error_type CALLING_CONVENTION HexadecimalStringObject_SetValue(HexadecimalStringObjectHandle* handle, BufferHandle* value);
139 
143  VANILLAPDF_API error_type CALLING_CONVENTION HexadecimalStringObject_Release(HexadecimalStringObjectHandle* handle);
144 
147 #ifdef __cplusplus
148 };
149 #endif
150 
151 #endif /* _C_STRING_OBJECT_H */
StringObjectHandle::StringObject_Type
error_type StringObject_Type(StringObjectHandle *handle, StringType *result)
Get derived type from current string.
StringObjectHandle::StringObject_Release
error_type StringObject_Release(StringObjectHandle *handle)
Decrement the internal reference counter.
StringType
StringType
Available types of strings.
Definition: c_string_object.h:42
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_SetValue
error_type HexadecimalStringObject_SetValue(HexadecimalStringObjectHandle *handle, BufferHandle *value)
Set strings new value.
HexadecimalStringObjectHandle::HexadecimalStringObject_GetValue
error_type HexadecimalStringObject_GetValue(HexadecimalStringObjectHandle *handle, BufferHandle **result)
Get strings current value.
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.
StringObjectHandle::StringObject_ToHexadecimal
error_type StringObject_ToHexadecimal(StringObjectHandle *handle, HexadecimalStringObjectHandle **result)
Reinterpret current object as HexadecimalStringObjectHandle.
LiteralStringObjectHandle::LiteralStringObject_SetValue
error_type LiteralStringObject_SetValue(LiteralStringObjectHandle *handle, BufferHandle *value)
Set strings new value.
StringObjectHandle::StringObject_SetValue
error_type StringObject_SetValue(StringObjectHandle *handle, BufferHandle *value)
Set strings new value.
StringObjectHandle::StringObject_ToLiteral
error_type StringObject_ToLiteral(StringObjectHandle *handle, LiteralStringObjectHandle **result)
Reinterpret current object as LiteralStringObjectHandle.
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...
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.
c_values.h
This file contains types and constants used as parameters or return values.
StringObjectHandle
Reprsents human readable text.
BufferHandle
Represents memory stored data.
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.