【プログラム班】開発メモ→MSXML 6.0 リファレンスに近くもない何か - 箱庭Project Wiki

※MSDNライブラリ英語版を参考に作成しています。

MSXML 6.0　リファレンス(に限りなく近くもない何か)

VARIANTについて

VARIANTについて

COMではデータを扱うのにVARIANT型の変数でやっているみたい。
文字列をVARIANTに変換する場合、variant_tクラスを使うと楽
例：

IXMLDOMDocument *p_dom;
VARIANT_BOOL ret;
...
if(FAILED(p_dom->load(_variant_t("NanikaNoData.xml", &ret))
{
...
}
 

BSTRについて

BSTRについて

COMで使われる文字コードはUnicodeで、BSTR型の変数で扱われる。
BSTR型の文字列を使う場合、bstr_tクラスを使うと楽
例：

bstr_t b_str;
IXMLDOMNode *p_child;
...
 
// bstr_t型に文字列を代入する
p_child->get_nodeName(b_str.GetAddress()); 
...
 
// 文字列の比較も簡単
if(b_str == bstr_t(TEXT("あいうえお")) {
...
}
 

VARIANT_BOOLについて

VARIANT_BOOLについて

COMで使用される真理値型。VARIANT_TRUE (真) か VARIANT_FALSE (偽) を格納できる。

IXMLDOMDocument

１つのXML文書を構成する。

• メンバ関数一覧

createAttribute関数

createAttribute関数

• 説明
  指定された名前の属性を作成する
• 引数
• 戻り値

createCDATASection関数

createCDATASection関数

createCDATASection関数

• 説明
  提供されたデータが含まれるCDATAセクションノードを作成する
• 引数
• 戻り値

createComment関数

createComment関数

createComment関数

HRESULT createComment(BSTR data, IXMLDOMComment **comment);
 

• 説明
  引数で指定されたデータが含まれるコメントノードを作成する
• 引数

引数名	説明
BSTR data[入力]
IXMLDOMComment **comment[出力]

• 戻り値

getElementsByTagName関数

getElementsByTagName関数

HRESULT getElementsByTagName(BSTR tagName, IXMLDOMNodeList **resutList);
 

• 説明
  指定された名前のノードのリストを取得する
• 引数

引数名	説明
BSTR tagName[入力]	取得したい要素の名前("*"を指定するとすべての要素を取得する)
IXMLDOMNodeList **resultList[出力]	指定した名前と一致した要素のリストへのポインタ

• 戻り値

HRESULT型

値	説明
S_OK	成功

load関数

load関数

HRESULT load(VARIANT xmlSource, VARIANT_BOOL *isSuccessful);
 

• 説明
  XML文書をファイルから読み込む
• 引数

引数名	説明
VARIANT xmlSource[入力]	読み込むXMLファイルのパス
VARIANT_BOOL *isSuccessful[出力]	関数の成功/失敗フラグ 読み込むが成功すればVARIANT_TRUEを、 失敗すればVARIANT_FALSEが格納される

• 戻り値

値	説明
S_OK	成功
S_FALSE	失敗
E_INVALIDARG	isSuccessfulにNULLが渡された場合この値が返る

get_documentElement関数

get_documentElement関数

HRESULT get_documentElement(IXMLDOMElement **DOMElement);
 

• 説明
  読み込んだXML文書のルート要素を取得する
• 引数

引数名	説明
IXMLDOMElement **DOMElement	ルート要素を格納するIXMLDOMElementオブジェクトのポインタ XMLファイルのルート要素が存在しない時、NULLを返す

• 戻り値

値	説明
S_OK	成功
S_FALSE	ルート要素を取得できなかった場合にこの値を返す

IXMLDOMNode

１つのノードを構成する。

• メンバ関数一覧

get_attributes関数

get_attributes関数

HRESULT get_attributes(IXMLDOMNamedNodeMap **attributeMap);
 

• 説明
  ノードの属性を取得する。
• 引数

引数名	説明
IXMLDOMNamedNodeMap **attributeMap[出力/返り値]	ノードから取得した属性のリストを受け取るポインタへのポインタ 取得先のノードが属性を持つことの出来るノードだった場合 : 属性のリストを返す(属性を一つも持っていない場合は要素0のリストを返す)。 そうでない場合 : NULLを返す。

• 戻り値

値	説明
S_OK	成功
S_FALSE	取得先のノードが属性を持つことの出来ない形式だった時
E_INVALIDARG	attributeMapにNULLを渡した場合

get_baseName関数

get_baseName関数

HRESULT get_baseName(BSTR *nameString);
 

• 説明
  ある名前空間内でのノードの名前を取得する。
  例 : 「<hako:niwa> ....</hako:niwa>」だった場合、「niwa」の部分を取得する。
• 引数

引数名	説明
BSTR *nameString	取得した名前を格納した文字列へのポインタ

• 戻り値

値	説明
S_OK	成功
S_FALSE	名前空間で制限されていないノードから取得しようとした場合
E_INVALIDARG	nameStringにNULLを渡した場合

get_childNodes関数

get_childNodes関数

HRESULT get_childNodes(IXMLDOMNodeList **childList);
 

• 説明
  子ノードを取得する。
• 引数

引数名	説明
IXMLDOMNodeList **childList[出力/返り値]	子ノードのリストへのポインタを格納するためのポインタ ※子ノードをもてないノードの場合でも、要素0のリストを返す。

• 戻り値

値	説明
S_OK	成功
E_INVALIDARG	childListがNULLだった場合

get_firstChild関数

get_firstChild関数

HRESULT get_firstChild(IXMLDOMNode **firstChild);
 

• 説明
  先頭の子ノードを取得する。
• 引数

引数名	説明
IXMLDOMNode **fistChild[出力/返り値]	取得した先頭の子ノードへのポインタを格納するポインタ 子ノードが無い場合、NULLが格納される

• 戻り値

値	説明
S_OK	成功
S_FALSE	子ノードを持っていなかった場合
E_INVALIDARG	firstChildにNULLを渡した場合

get_lastChild関数

get_lastChild関数

HRESULT get_lastChild(IXMLDOMNode **lastChild);
 

• 説明
  末尾の子ノードを取得する。
• 引数

引数名	説明
IXMLDOMNode **lastChild[出力/返り値]	取得した末尾の子ノードへのポインタを格納するポインタ 子ノードが無い場合、NULLが格納される

• 戻り値

値	説明
S_OK	成功
S_FALSE	子ノードを持っていなかった場合
E_INVALIDARG	lastChildにNULLを渡した場合

get_nodeType関数

get_nodeType関数

HRESULT get_nodeType(DOMNodeType *type);
 

• 説明
  ノードの種類を取得する。この関数によってノードがタグであるか属性であるかを知ることができる。
• 引数

引数名	説明
DOMNodeType *type	ノードの種類を格納先のポインタ

• • typeに渡される値一覧

マクロ名	説明
NODE_ELEMENT	要素(タグ) 「<hako>...</hako>」のこと
NODE_ATTRIBUTE	要素 hako="niwa"の部分
NODE_TEXT	「<hako>...</hako>」の「...」の部分
NODE_CDATA_SECTION	CDATAセクション <![CDATA[...]]>のこと
NODE_ENITITY_REFERENCE	実体参照(?)
NODE_ENITITY	拡張された実体(?)
NODE_PROCESSING_INSTRUCTION	XML処理命令 <?...?>のこと
NODE_COMMENT	コメント 「<!--...-->」のこと
NODE_DOCUMENT	XMLドキュメントのルート要素
NODE_DOCUMENT_TYPE	<!DOCTYPE>タグによって定義されたノードのこと
NODE_DOCUMENT_FLAGMENT	(?)
NODE_NOTATION	(?)

• 戻り値

値	説明
S_OK	成功
E_INVALIDARG	typeにNULLを渡した場合

appendChild関数

appendChild関数

HRESULT appendChild(IXMLDOMNode *newChild, IXMLDOMNode **outNewChild);
 

• 説明
  現在のノードの子ノードの最後に新しい子ノードを追加する
• 引数

引数名	説明
IXMLDOMNode *newChild[入力]	新しく追加する子ノード
IXMLDOMNode **outNewChild[出力]	リストに追加した新しい子ノードへのポインタが返る。必要ない場合はNULLを指定。

• 戻り値

値	説明
S_OK	成功
E_INVALIDARG	newChildがNULLだった場合
E_FAIL	他のエラーが発生した場合

cloneNode関数

cloneNode関数

HRESULT cloneNode(VARIANT_BOOL deep, IXMLDOMNode **cloneRoot);
 

• 説明
  ノードのコピーを作成する
• 引数

引数名	説明
VARIANT_BOOL deep[入力]	ノードをコピーする際、コピーしたいノード以下のすべて子ノードも一緒にコピーするかどうかを指定します。 VARIANT_TRUE : コピーしたいノードとそれ以下のノード階層すべてをコピーする VARIANT_FALSE : 子ノードをコピーせず、コピーしたいノードのみをコピーする。
IXMLDOMNode **cloneRoot[出力]	作成されたノードのコピーのポインタ

• 戻り値

値	説明
S_OK	成功
E_INVALIDARG	cloneRootがNULLだった場合

get_nodeName関数

get_nodeName関数

HRESULT get_nodeName(BSTR *name);
 

• 説明
  ノードの名前を取得する。
• 引数

引数名	説明
BSTR *name[出力/返り値]	取得した文字列のポインタを格納するBSTR型の変数へのポインタ

• 戻り値

値	説明
S_OK	成功
E_INVALIDARG	nameがNULLだった場合

get_nodeValue関数

get_nodeValue関数

HRESULT get_nodeValue(VARIANT *value);
 

• 説明
  ノードに設定された値を取得する
  例 : 属性の時は「hako="niwa"」の「niwa」の部分
• 引数

引数名	説明
VARIANT *value	取得した値を格納するVARIANT型の変数へのポインタ

• 戻り値

値	説明

getElementsByTagName関数

getElementsByTagName関数

HRESULT getElementsByTagName(BSTR tagName, IXMLDOMNodeList **resutList);
 

• 説明
  あるノード内の指定された名前のノードのリストを取得する
• 引数

引数名	説明
BSTR tagName[入力]	取得したい要素の名前("*"を指定するとすべての要素を取得する)
IXMLDOMNodeList **resultList[出力]	指定した名前と一致した要素のリストへのポインタ

• 戻り値

HRESULT型

値	説明
S_OK	成功

get_firstChild関数

get_firstChild関数

HRESULT get_firstChild(IXMLDOMNode **firstChild);
 

• 説明
  要素内にある先頭の子要素を取得する(ノード内にある先頭の子ノードを取得する)
• 引数

引数名	説明
IXMLDOMNode **firstChild[出力]	先頭の子要素のポインタを格納するオブジェクト 子要素がない時はNULLが渡される

• 戻り値

値	説明
S_OK	成功
S_FALSE	子要素がない(子ノードがない)
E_INVALIDARG	firstChildにNULLが渡させた場合(エラー)

get_lastChild関数

get_lastChild関数

HRESULT get_lastChild(IXMLDOMNode **lastChild);
 

• 説明
  要素内にある終端の子要素を取得する(ノード内にある終端の子ノードを取得する)
• 引数

引数名	説明
IXMLDOMNode **lastChild[出力]	終端の子要素のポインタを格納するオブジェクト 子要素がない時はNULLが渡される

• 戻り値

値	説明
S_OK	成功
S_FALSE	子要素がない(子ノードがない)
E_INVALIDARG	firstChildにNULLが渡させた場合(エラー)

get_nextSibling関数

get_nextSibling関数

HRESULT get_nextSibing(IXMLDOMNode **nextSibing);
 

• 説明
  同一要素内にある一つ次の要素を取得する
  (右のノードを取得する)
• 引数

引数名	説明
IXMLDOMNode **nextSibling[出力]	一つ次の要素へのポインタを格納するオブジェクトへのポインタ

• 戻り値

値	説明
S_OK	成功
S_FALSE	一つ次の要素がない(右のノードがない)
E_INVALIDARG	nextSiblingにNULLが渡させた場合(エラー)

get_previousSibling関数

get_previousSibling関数

HRESULT get_previousSibing(IXMLDOMNode **previousSibing);
 

• 説明
  同一要素内にある一つ前の要素を取得する
  (右のノードを取得する)
• 引数

引数名	説明
IXMLDOMNode **previousSibling[出力]	一つ前のの要素へのポインタを格納するオブジェクトへのポインタ

• 戻り値

値	説明
S_OK	成功
S_FALSE	一つ前の要素がない(右のノードがない)
E_INVALIDARG	previousSiblingにNULLが渡させた場合(エラー)

---

テンプレ

関数

関数

• 説明
  
• 引数

引数名	説明

• 戻り値

値	説明

---