Main Page | Modules | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals

XML


Files

file  psXML.h
 Contains basic XML definitions and operations.

Typedefs

typedef xmlDocPtr psXMLDoc
 XML wrapper pointing to an XML document in memory.

Functions

psXMLDocpsXMLDocAlloc (void)
 Allocates a new psXMLDoc.
psXMLDocpsMetadataToXMLDoc (const psMetadata *md)
 Converts a psMetadata data structure to a complete psXMLDoc (in memory).
psMetadatapsXMLDocToMetadata (const psXMLDoc *doc)
 Converts a complete psXMLDoc (in memory) to a psMetadata data structure.
psXMLDocpsXMLParseFile (const char *filename)
 Loads the data in a named file into a complete psXMLDoc (in memory).
bool psXMLDocToFile (const psXMLDoc *doc, const char *filename)
 Writes out a complete psXMLDoc (in memory) to a named file.
psXMLDocpsXMLParseMem (const char *buffer, int size)
 Accepts a block of memory and parses it into a complete psXMLDoc (also in memory).
bool psXMLDocToMem (const psXMLDoc *doc, char *buffer)
 Accepts a complete psXMLDoc (in memory) and parses it into a block of memory.
psXMLDocpsXMLParseFD (int fd)
 Reads from a file descriptor and converts the incoming data to a complete psXMLDoc (in memory).
bool psXMLDocToFD (const psXMLDoc *doc, int fd)
 Reads from a complete psXMLDoc (in memory) and writes it to a file descriptor.


Typedef Documentation

typedef xmlDocPtr psXMLDoc
 

XML wrapper pointing to an XML document in memory.

Definition at line 41 of file psXML.h.


Function Documentation

psXMLDoc* psMetadataToXMLDoc const psMetadata md  ) 
 

Converts a psMetadata data structure to a complete psXMLDoc (in memory).

Returns:
psXMLDoc* Pointer to XML document from read
Parameters:
md  psMetadata structure to read

psXMLDoc* psXMLDocAlloc void   ) 
 

Allocates a new psXMLDoc.

Returns:
psXMLDoc* a new psXMLDoc object

bool psXMLDocToFD const psXMLDoc doc,
int  fd
 

Reads from a complete psXMLDoc (in memory) and writes it to a file descriptor.

Returns:
bool: True on success or false otherwise.
Parameters:
doc  psXMLDoc to read
fd  File descriptor to write

bool psXMLDocToFile const psXMLDoc doc,
const char *  filename
 

Writes out a complete psXMLDoc (in memory) to a named file.

Returns:
bool: True on success or false otherwise.
Parameters:
doc  psXMLDoc to read
filename  Filename of file to be written

bool psXMLDocToMem const psXMLDoc doc,
char *  buffer
 

Accepts a complete psXMLDoc (in memory) and parses it into a block of memory.

Returns:
bool: True on success or false otherwise.
Parameters:
doc  psXMLDoc to read
buffer  Buffer to write

psMetadata* psXMLDocToMetadata const psXMLDoc doc  ) 
 

Converts a complete psXMLDoc (in memory) to a psMetadata data structure.

Returns:
psMetadata* Pointer to psMetadata data structure from read
Parameters:
doc  psXMLDoc to read

psXMLDoc* psXMLParseFD int  fd  ) 
 

Reads from a file descriptor and converts the incoming data to a complete psXMLDoc (in memory).

Returns:
psXMLDoc* Pointer to resulting XML document from read
Parameters:
fd  File descriptor to read

psXMLDoc* psXMLParseFile const char *  filename  ) 
 

Loads the data in a named file into a complete psXMLDoc (in memory).

Returns:
psXMLDoc* Pointer to resulting XML document from read
Parameters:
filename  Filename of file to be read

psXMLDoc* psXMLParseMem const char *  buffer,
int  size
 

Accepts a block of memory and parses it into a complete psXMLDoc (also in memory).

Returns:
psXMLDoc* Pointer to resulting XML document from read
Parameters:
buffer  Buffer to read
size  Size of buffer


Generated on Wed Sep 14 10:43:48 2005 for Pan-STARRS Foundation Library by  doxygen 1.4.2