標頭檔案引用

xml2config --cflags

庫檔案引用

xml2config --libs

主要標頭檔案

parse.h

tree.h

xpath.h

簡單例程

Makefile:

INCLUDE=-I./ -I$HOME/include `xml2config --cflags`

LIBRARY=-L./ -L$HOME/lib `xml2config --libs`

*.c或*.cpp

#include <libxml/parse.h>

#include <libxml/tree.h>

#include <libxml/xpath.h>

函式功能

在分析XML資料是，去除空白字元。如果不去除空白字元，則這些字元也會被當做一個node來處理

函式介面

int  xmlKeepBlanksDefault(int val)

引數說明

val：0或者1。0表示去除空白字元，1表示不去除

返回值：0表示設定失敗，1表示設定成功，一般不用判斷

簡單例程

xmlKeepBlanksDefault(0);

函式功能

將XML檔案從硬碟上載入到記憶體中，並且生成DOM樹。使用完畢之後，需要用xmlFreeDoc()來釋放資源

函式介面

xmlDocPtr xmlParseFile(const char * filename)

引數說明

filename：XML檔名稱。

返回值：如果載入成功，則返回這個文件的根節點。否則返回NULL

簡單例程

xmlDodPtr pdoc;

pdoc = xmlParseFile("123.xml");

if( pdoc == NULL )

{

     printf("Fail to parse XML file.\n");

}

函式功能

將記憶體中的DOM樹，儲存到硬碟上，生成一個帶格式的XML檔案

函式介面

int  xmlSaveFormatFileEnc(const char * filename,  xmlDocPtr cur,

     const char * encoding, int format)

引數說明

filename：需要儲存的檔案的名稱

cur：需要儲存的XML文件

encoding：匯出檔案的編碼型別，或者為NULL

format：是否格式化。0表示不格式化，1表示需要格式化。注意：只有當xmlIndentTreeOutput設定為1，或者xmlKeepBlanksDefault(0)時，format設定為1才能生效

返回值：寫入檔案中的位元組數量

簡單例程

xmlDodPtr pdoc;

pdoc = xmlParseFile("123.xml");

if( pdoc == NULL )

{

     printf("Fail to parse XML file.\n");

}

Do_something_with_pdoc();

int filesize;

filesize = xmlSaveFormatFileEnc("321.xml", pdoc, "gb2312",1);

if(filesize == -1)

{

     printf("Fail to save XML to file.\n");

}

函式功能

將一塊記憶體中的XML資料生成一個DOM樹。使用完畢之後，需要用xmlFreeDoc()來釋放資源

函式介面

xmlDocPtr xmlParseMemory(const char * buffer, int size)

引數說明

buffer：存放XML格式資料的記憶體區

size：記憶體中XML格式資料的長度

返回值：如果載入成功，則返回這個文件的根節點；否則返回NULL

簡單例程

char *buffer;

int size;

xmlDocPtr pdoc;

// read_data_to_buffer

buffer = ……

size = strlen(buffer);

pdoc = xmlParseMemory(buffer, size);

if( pdoc == NULL)

{

     printf("Fail to parse XML buffer.\n");

}

函式功能

將DOM樹匯出到記憶體中，形成一個XML格式的資料

函式介面

void xmlDocDumpFormatMemoryEnc(xmlDocPtr out_doc, xmlChar ** doc_txt_ptr,

     int * doc_txt_len, const char * txt_encoding, int format)

引數說明

out_doc：需要輸出成為一個buffer的XML文件

doc_txt_ptr：輸出文件的記憶體區。由該函式在內部申請。使用完成之後，必須呼叫xmlFree()函式來釋放該記憶體塊

doc_txt_len：輸出文件記憶體區的長度

txt_encoding：輸出文件的編碼型別

format：是否格式化。0表示不格式化，1表示需要格式化。注意只有當xmlIndentTreeOutput設定為1，或者xmlKeepBlanksDefault(0)時，format設定為1才能生效

簡單例程

xmlChar *outbuf;

int outlen;

xmlDocPtr pdoc;

pdoc = ……

xmlDocDumpFormatMemoryEnc(pdoc, &outbuf, &outlen, "gb2312", 1);

xmlFree(outbuf);

函式功能

在記憶體中建立一個新的XML文件。所建立的文件需要使用xmlFreeDoc()來釋放資源

函式介面

xmlDocPtr xmlNewDoc     (const xmlChar * version)

引數說明

version：XML標準的版本，目前只能指定為“1.0”

簡單例程

xmlDocPtr pdoc ;

pdoc = xmlNewDoc((const xmlChar*)"1.0");

if( pdoc == NULL )

{

     printf(“Fail to create new XML doc.\n”);

}

函式功能

釋放記憶體中的XML文件

函式介面

void xmlFreeDoc(xmlDocPtr cur)

引數說明

cur：需要釋放的XML文件

簡單例程

xmlDocPtr pdoc ;

pdoc = xmlNewDoc((const xmlChar*)"1.0");

if( pdoc == NULL )

{

     printf(“Fail to create new XML doc.\n”);

}

xmlFreeDoc(podc);

函式功能

獲得根節點

函式介面

xmlNodePtr    xmlDocGetRootElement(xmlDocPtr doc)

引數說明

doc：XML文件控制代碼。

返回值：XML文件的根節點，或者NULL。

使用流程

① 解析好文件的根節點指標，應用使用該指標可以遍歷XML檔案

② xmlNodePtr的next欄位，指向下一個同級XML節點

③ properties欄位為xmlAttr型別，指向該XML節點的屬性

④ children欄位為xmlNodePtr型別，指向該XML節點的子節點

簡單例程

xmlDocPtr pdoc ;

xmlNodePtr root ;

pdoc = xmlParseFile("123.xml");

if( pdoc == NULL )

{

     printf("Fail to parse XML File.\n");

     return ;

}

root = xmlDocGetRootElement(pdoc);

if( root == NULL)

{

     printf("Fail to get root element\n");

     return;

}

函式功能

設定根節點

函式介面

xmlNodePtr    xmlDocSetRootElement(xmlDocPtr doc, xmlNodePtr root)

引數說明

doc：XML文件控制代碼

root：XML文件的新的根節點

返回值：如果該文件原來有根節點，則返回根節點，否則返回NULL

簡單例程

xmlDocPtr pdoc ;

xmlNodePtr root;

pdoc = xmlNewDoc((const xmlChar*)"1.0");

if( pdoc == NULL )

{

     printf("Fail to create new XML doc.\n");

     return;

}

root = xmlNewDocNode(pdoc, NULL, (const xmlChar*)"root", NULL);

if( root == NULL )

{

     printf("Fail to create doc node.\n");

     return ;

}

xmlDocSetRootElement(pdoc, root);

函式功能

獲得節點的內容

函式介面

xmlChar * xmlNodeGetContent  (xmlNodePtr cur)

引數說明

cur：節點的指標

返回值：節點的文字內容。如果該節點沒有文字內容，則返回NULL。當返回值不為NULL時，需要用xmlFree()函式來釋放返回的資源

簡單例程

xmlNodePtr node;

xmlChar* content;

node = ….

content = xmlNodeGetContent(node);

xmlFree(content);

函式功能

設定節點的內容長度

函式介面

void xmlNodeSetContentLen(xmlNodePtr cur, const xmlChar * content,  int len)

引數說明

cur：節點的指標

content：節點的新文字內容

len：節點新文字內容的長度

簡單例程

xmlNodePtr node;

xmlChar* content;

int len;

content = (xmlChar*)"1234567890";

len = strlen((char*)content);

xmlNodeSetContentLen(node, content, len);

函式功能

在節點的內容後面新增新的內容

函式介面

void xmlNodeAddContentLen(xmlNodePtr cur,  const xmlChar * content,  int len)

引數說明

cur：節點的指標

content：節點的新加的文字內容

len：節點新加的文字內容的長度

簡單例程

xmlNodePtr node;

xmlChar* content;

int len;

content = (xmlChar*)"1234567890";

len = strlen((char*)content);

xmlNodeAddContentLen(node, content, len);

函式功能

獲得節點的屬性

函式介面

xmlChar * xmlGetProp(xmlNodePtr node, const xmlChar * name)

引數說明

node：XML節點的指標

name：該節點的屬性的名稱

返回值：該屬性的值或者為NULL。如果不為NULL，則需要用xmlFree()來釋放資源

簡單例程

xmlNodePtr node;

xmlChar* prop;

node = ….

prop = xmlGetProp(node, (const xmlChar*)"name");

if( prop != NULL)

     xmlFree(prop);

函式功能

設定節點的屬性（如果該屬性已經存在，則替換其值）

函式介面

xmlAttrPtr xmlSetProp(xmlNodePtr node, const xmlChar * name, const xmlChar * value)

引數說明

node：需要設定屬性的節點

name：屬性的名稱

value：屬性的值

返回值：該屬性節點的指標

簡單例程

xmlNodePtr node;

xmlAttrPtr attr;

node = ….

attr = xmlSetProp(node, (cosnt xmlChar*)"Dept-Name", (const xmlChar*)"ES");

if( attr == NULL)

{

     printf("Fail to set prop of this node.\n");

}

函式功能

生成xpath的上下文關係控制代碼

函式介面

xmlXPathContextPtr xmlXPathNewContext(xmlDocPtr doc)

引數說明

doc：需要處理的XML文件

返回值：該文件的XPath上下文關係控制代碼或者NULL。該返回控制代碼由函式內部申請，此函式呼叫者需要用xmlXPathFreeContext來釋放

簡單例程

xmlDocPtr pdoc;

xmlXPathContextPtr xpathctx;

pdoc = ….

xpathctx = xmlXPathNewContext(pdoc);

if( xpathctx != NULL)

     xmlXPathFreeContext(xpathctx);

函式功能

釋放xpath的上下文關係控制代碼

函式介面

void xmlXPathFreeContext(xmlXPathContextPtr ctxt)

引數說明

ctxt：需要釋放的xpath上下文關係控制代碼

簡單例程

參見xmlXPathNewContext()的例程

函式功能

執行xpath的表示式，返回結果內容節點集合

XPath表示式的表示方法，請參考：

http://www.zvon.org/xxl/XPathTutorial/General/examples.html

函式介面

xmlXPathObjectPtr  xmlXPathEvalExpression (const xmlChar * str,

                             xmlXPathContextPtr ctxt)

引數說明

str：xpath表示式

ctxt：xpath的上下文關係控制代碼

返回值：滿足表示式的結果集合或者為NULL。該返回控制代碼由函式內部申請，此函式呼叫者需要用xmlXPathFreeObject()來釋放

簡單例程

xmlDocPtr pdoc;

xmlXPathContextPtr xpathctx;

xmlXPathObjectPtr xpathobj;

pdoc = ….

xpathctx = xmlXPathNewContext(pdoc);

if( xpathctx == NULL)

{

     printf("Fail to create xpath context.\n");

     return ;

}

Xpathobj = xmlXPathEvalExpression(BAD_CAST "//@value", xpathctx);

if( xpathobj == NULL)

{

     printf("Fail to evaluate xpath expression.\n");

     xmlXPathFreeContext(xpathctx);

     return;

}

xmlXPathFreeObject(xpathobj);

xmlXPathFreeContext(xpathctx);

結果集說明：

xpathobj-> nodesetval：儲存結果列表，如果為NULL，表示無結果

xpathObj->nodesetval->nodeNr：表示結果的數量

xpathObj->nodesetval->nodeTab：表示結果的陣列，可以通過下標訪問

例如：

int number;

xmlNodePtr node;

if( xpathobj-> nodesetval == NULL)

     number = 0;

else

     number = xpathObj->nodesetval->nodeNr;

for(int i=0;i<number;i++)

{

     node = xpathObj->nodesetval->nodeTab[i];

     do_some_work_with_node();

}

函式功能

釋放xpath表示式運算結果集

函式介面

void xmlXPathFreeObject(xmlXPathObjectPtr obj)

引數說明

obj：需要釋放的xpath表示式運算結果集合

簡單例程

參見xmlXPathEvalExpression()的例程