API-ref-idrs16/html_c/_c_serialization__interface_8h_source.html

#ifndef CSERIALIZATION_INTERFACE_H


#define CSERIALIZATION_INTERFACE_H


#include "idrsstd_interface.h"

#include "CObjPtr_interface.h"

#include "CPageContent_interface.h"

#include "EnumDefinitions_interface.h"

#include "CIDRS_interface.h"


#include "idrs_common.h"


#ifdef __cplusplus

extern "C" {

#endif


CSerialization CSerialization_Create(const CIDRS argIdrs, enum SerializationFormat const evSerializationVersion, idrs_exception *pargException);


CSerialization CSerialization_Create2(const CIDRS argIdrs, idrs_exception *pargException);


CPage CSerialization_LoadPage(const CSerialization argCSerialization, const idrs_string strFileName, idrs_exception *pargException);


CPage CSerialization_LoadPage2(const CSerialization argCSerialization, IByteStream argStream, idrs_exception *pargException);


void CSerialization_SavePage(const CSerialization argCSerialization, const CPage argPage, const idrs_string strFileName, idrs_exception *pargException);


void CSerialization_SavePage2(const CSerialization argCSerialization, const CPage argPage, IByteStream argStream, idrs_exception *pargException);


CPageContent CSerialization_LoadPageContent(const CSerialization argCSerialization, const idrs_string strFileName, idrs_exception *pargException);


CPageContent CSerialization_LoadPageContent2(const CSerialization argCSerialization, IByteStream argStream, idrs_exception *pargException);


void CSerialization_SavePageContent(const CSerialization argCSerialization, const CPageContent argPageContent, const idrs_string strFileName, idrs_exception *pargException);


void CSerialization_SavePageContent2(const CSerialization argCSerialization, const CPageContent argPageContent, IByteStream argStream, idrs_exception *pargException);


void CSerialization_SetFormat(CSerialization argCSerialization, enum SerializationFormat const evSerializationVersion, idrs_exception *pargException);


enum SerializationFormat CSerialization_GetFormat(const CSerialization argCSerialization, idrs_exception *pargException);


void CSerialization_Destroy(CSerialization argCSerialization, idrs_exception *pargException);


#ifdef __cplusplus

}

#endif /* __cplusplus */


#endif /* CSERIALIZATION_INTERFACE_H */

CIDRS_interface.h
Interface for CIDRS wrapper.

CObjPtr_interface.h
Interface for CObjPtr wrapper.

CPageContent_interface.h
Interface for CPageContent wrapper.

CSerialization_Create2
CSerialization CSerialization_Create2(const CIDRS argIdrs, idrs_exception *pargException)
Create the CSerialization instance.

CSerialization_SavePageContent
void CSerialization_SavePageContent(const CSerialization argCSerialization, const CPageContent argPageContent, const idrs_string strFileName, idrs_exception *pargException)
SavePage saves a page's content into its serialized format.

CSerialization_SavePage
void CSerialization_SavePage(const CSerialization argCSerialization, const CPage argPage, const idrs_string strFileName, idrs_exception *pargException)
SavePage saves a page object into its serialized format.

CSerialization_LoadPage2
CPage CSerialization_LoadPage2(const CSerialization argCSerialization, IByteStream argStream, idrs_exception *pargException)
LoadPage loads a page from its serialized format.

CSerialization_SavePage2
void CSerialization_SavePage2(const CSerialization argCSerialization, const CPage argPage, IByteStream argStream, idrs_exception *pargException)
SavePage saves a page object into its serialized format.

CSerialization_SetFormat
void CSerialization_SetFormat(CSerialization argCSerialization, enum SerializationFormat const evSerializationVersion, idrs_exception *pargException)
Set the serialization format which will be used when saving a page or its content.

CSerialization_Destroy
void CSerialization_Destroy(CSerialization argCSerialization, idrs_exception *pargException)
Destroys a CSerialization handle.

CSerialization_LoadPage
CPage CSerialization_LoadPage(const CSerialization argCSerialization, const idrs_string strFileName, idrs_exception *pargException)
LoadPage loads a page from its serialized format.

CSerialization_LoadPageContent2
CPageContent CSerialization_LoadPageContent2(const CSerialization argCSerialization, IByteStream argStream, idrs_exception *pargException)
LoadPageContent loads zones from the given stream.

CSerialization_SavePageContent2
void CSerialization_SavePageContent2(const CSerialization argCSerialization, const CPageContent argPageContent, IByteStream argStream, idrs_exception *pargException)
SavePage saves a page's content into its serialized format.

CSerialization_Create
CSerialization CSerialization_Create(const CIDRS argIdrs, enum SerializationFormat const evSerializationVersion, idrs_exception *pargException)
Create the CSerialization instance.

CSerialization_LoadPageContent
CPageContent CSerialization_LoadPageContent(const CSerialization argCSerialization, const idrs_string strFileName, idrs_exception *pargException)
LoadPageContent loads page content from the given file.

CSerialization_GetFormat
enum SerializationFormat CSerialization_GetFormat(const CSerialization argCSerialization, idrs_exception *pargException)
Get the serialization format which will be used when saving a page or its content.

EnumDefinitions_interface.h
Interface for EnumDefinitions wrapper.

SerializationFormat
SerializationFormat
Definition of the available versions of serialization.
Definition EnumDefinitions_interface.h:134

CPageContent
CPageContent represents the results content of CPage.

CPage
The CPage class manages a page in the IDRS.

CSerialization
The CSerialization class manages loading and saving of page content for the iDRS.

IByteStream
IByteStream defines the interface required to provide read, write and seek functionalities for a sequ...

idrs_string
Class that handles a string of characters.

idrs_common.h

idrsstd_interface.h
Interface for idrsstd wrapper.