Vanilla.PDF  2.0.0
Cross-platform toolkit for creating and modifying PDF documents
c_name_object.h
Go to the documentation of this file.
1#ifndef _C_NAME_OBJECT_H
2#define _C_NAME_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
9extern "C"
10{
11#endif
12
34 VANILLAPDF_API error_type CALLING_CONVENTION NameObject_Create(NameObjectHandle** result);
35
39 VANILLAPDF_API error_type CALLING_CONVENTION NameObject_CreateFromEncodedString(string_type value, NameObjectHandle** result);
40
44 VANILLAPDF_API error_type CALLING_CONVENTION NameObject_CreateFromDecodedString(string_type value, NameObjectHandle** result);
45
49 VANILLAPDF_API error_type CALLING_CONVENTION NameObject_GetValue(const NameObjectHandle* handle, BufferHandle** result);
50
54 VANILLAPDF_API error_type CALLING_CONVENTION NameObject_SetValue(NameObjectHandle* handle, BufferHandle* value);
55
59 VANILLAPDF_API error_type CALLING_CONVENTION NameObject_Equals(const NameObjectHandle* handle, const NameObjectHandle* other, boolean_type* result);
60
64 VANILLAPDF_API error_type CALLING_CONVENTION NameObject_Hash(const NameObjectHandle* handle, size_type* result);
65
69 VANILLAPDF_API error_type CALLING_CONVENTION NameObject_ToObject(NameObjectHandle* handle, ObjectHandle** result);
70
74 VANILLAPDF_API error_type CALLING_CONVENTION NameObject_FromObject(ObjectHandle* handle, NameObjectHandle** result);
75
79 VANILLAPDF_API error_type CALLING_CONVENTION NameObject_Release(NameObjectHandle* handle);
80
83#ifdef __cplusplus
84};
85#endif
86
87#endif /* _C_NAME_OBJECT_H */
c_export.h
This file contains macro declarations for importing and exporting symbols from library boundaries.
c_handles.h
This file contains all type forward declarations returned by the library API.
c_values.h
This file contains types and constants used as parameters or return values.
BufferHandle
Represents memory stored data.
NameObjectHandle
A name object is an atomic symbol uniquely defined by a sequence of characters.
NameObjectHandle::NameObject_Equals
error_type CALLING_CONVENTION NameObject_Equals(const NameObjectHandle *handle, const NameObjectHandle *other, boolean_type *result)
Compares two name objects.
NameObjectHandle::NameObject_CreateFromDecodedString
error_type CALLING_CONVENTION NameObject_CreateFromDecodedString(string_type value, NameObjectHandle **result)
Creates a new NameObject instance from decoded data without PDF syntax.
NameObjectHandle::NameObject_Release
error_type CALLING_CONVENTION NameObject_Release(NameObjectHandle *handle)
Decrement the internal reference counter.
NameObjectHandle::NameObject_Hash
error_type CALLING_CONVENTION NameObject_Hash(const NameObjectHandle *handle, size_type *result)
Get object hash code.
NameObjectHandle::NameObject_CreateFromEncodedString
error_type CALLING_CONVENTION NameObject_CreateFromEncodedString(string_type value, NameObjectHandle **result)
Creates a new NameObject instance from PDF encoded data.
NameObjectHandle::NameObject_Create
error_type CALLING_CONVENTION NameObject_Create(NameObjectHandle **result)
Creates a new NameObject instance.
NameObjectHandle::NameObject_ToObject
error_type CALLING_CONVENTION NameObject_ToObject(NameObjectHandle *handle, ObjectHandle **result)
Reinterpret current object as ObjectHandle.
NameObjectHandle::NameObject_GetValue
error_type CALLING_CONVENTION NameObject_GetValue(const NameObjectHandle *handle, BufferHandle **result)
Get names binary representation.
NameObjectHandle::NameObject_FromObject
error_type CALLING_CONVENTION NameObject_FromObject(ObjectHandle *handle, NameObjectHandle **result)
Convert ObjectHandle to NameObjectHandle.
NameObjectHandle::NameObject_SetValue
error_type CALLING_CONVENTION NameObject_SetValue(NameObjectHandle *handle, BufferHandle *value)
Set names new value.
ObjectHandle
Base class for syntactic tokens.
error_type
uint32_t error_type
This is return value type of all API functions.
Definition c_types.h:25
boolean_type
int8_t boolean_type
Boolean type supported in C.
Definition c_types.h:31
size_type
uint32_t size_type
Size type defined in standard library.
Definition c_types.h:62
string_type
const char * string_type
C-Style string.
Definition c_types.h:82