Parse
最終更新日: 2010年12月1日
適用対象: SharePoint Foundation 2010
指定されたドキュメントをパースし、抽出したドキュメント プロパティをプロパティ バッグに書き出します。
HRESULT Parse(
ILockBytes *pilb,
IParserPropertyBag *pibag,
VARIANT_BOOL *pfChanged
);
パラメーター
pilb
[in] パース対象ドキュメント。
pilbag
[in] ドキュメント プロパティを書き出すプロパティ バッグ オブジェクト。
pfChanged
[out] パーサーがドキュメントを変更したかどうか。パーサーがドキュメントを変更した場合は True、変更していない場合は False。
戻り値
パーサー メソッドは、一般的な HRESULT 値を返します。通常、パーサーは、正常に終了した場合は正の OK 値を返し、失敗した場合は負の FAIL 値を返す必要があります。
コメント
Microsoft SharePoint Foundation は、パースしようとするドキュメントに対して指定済みのプロパティを登録したプロパティ バッグ オブジェクトを用意し、これを pilb 引数としてメソッドに渡します。
パーサーがこのメソッドを実行した後、SharePoint Foundation はプロパティ バッグの中身を見て、ドキュメントに適用可能な列に一致するプロパティを調べます。次に、このプロパティを昇格します。プロパティの昇格とは、ドキュメント プロパティ値を対応するドキュメント ライブラリ列に書き出す、という処理のことです。SharePoint Foundation が昇格させるのは、ドキュメントに適用可能な列に一致するプロパティに限ります。
SharePoint Foundation はさらに、ドキュメント プロパティ コレクション全体をハッシュ テーブルに格納します。プログラム上ではこのハッシュ テーブルに、SPFile.Properties プロパティを使ってアクセスできます。
パーサーがドキュメントを変更し、pfChanged 引数によって示されている場合は、SharePoint Foundation は更新されたドキュメントをドキュメント ライブラリにアップロードします。
詳細については、「ドキュメント プロパティの昇格と降格」を参照してください。