IFilter::GetChunk メソッド (filter.h)

  • [アーティクル]

注意

Indexing Service は Windows XP の時点ではサポートされなくなり、Windows 8 の時点では使用できません。 代わりに、クライアント側 検索には Windows Search を使用し、サーバー側の検索には Microsoft Search Server Express を使用します。

フィルターを次のチャンクの先頭、または GetChunk メソッドの最初の呼び出しである場合は最初のチャンクに配置し、現在のチャンクの説明を返します。

構文

SCODE GetChunk(
  [out] STAT_CHUNK *pStat
);

パラメーター

[out] pStat

現在のチャンクの説明を含む STAT_CHUNK 構造体へのポインター。

戻り値

このメソッドは、これらの値のいずれかを返すことができます。

リターン コード 説明
S_OK
 操作は正常に完了しました。
FILTER_E_END_OF_CHUNKS
 前のチャンクは最後のチャンクです。
FILTER_E_EMBEDDING_UNAVAILABLE
 次のチャンクは埋め込みであり、コンテンツ フィルターは使用できません。
FILTER_E_LINK_UNAVAILABLE
 次のチャンクはリンクであり、コンテンツ フィルターは使用できません。
FILTER_E_PASSWORD
 パスワードまたはその他のセキュリティ関連のアクセスエラー。
FILTER_E_ACCESS
一般的なアクセスエラー。

解説

pStat がCHUNK_NO_BREAKと等しい breakType メンバーを持つSTAT_CHUNK構造体を指す場合、idChunk メンバーのみが新しいチャンク識別子 (ID) 値で更新されます。 STAT_CHUNK構造体の他のメンバーは変更されません。

内部値型プロパティ ( CHUNKSTATE 列挙値がCHUNK_VALUEのチャンク) は、CHUNK_NO_BREAKを使用して連結することはできません。 1 つの単語は、2 つ以上の接着チャンクにまたがることはできません。

チャンク ID 0 が無効です。

GetChunk メソッドが初めて呼び出される前に、現在のチャンクはありません。 エラーが発生した後、 GetChunk メソッドの次の呼び出しFILTER_E_END_OF_CHUNKS以外の何かのコードを返します。それでも、使用できないチャンクの後に次のチャンクが取得されます。

呼び出し元へのメモ

GetChunk メソッドが終了すると、*pStat で説明されているチャンクが現在のチャンクになります。 チャンク記述子は 、GetChunk メソッドを呼び出すルーチンによって所有されていますが、プロパティの仕様で設定できるプロパティ名ポインターは 、GetChunk メソッドによって所有されているため、解放しないでください。

実装者へのメモ

リンクオブジェクトまたは埋め込みオブジェクトのコンテンツ フィルターの GetChunk メソッドの呼び出しがFILTER_E_END_OF_CHUNKSを返す場合、実装はリンクオブジェクトまたは埋め込みオブジェクトの次のチャンクを返す必要があります。 たとえば、ドキュメントに 2 つの埋め込みオブジェクトがあり、最初のオブジェクトがFILTER_E_END_OF_CHUNKS返された場合、外部コンテンツ フィルターは埋め込みオブジェクトのコンテンツ フィルターの GetChunk メソッドを呼び出す必要があります。

埋め込みオブジェクトまたはリンク オブジェクトで GetChunk メソッドを呼び出した結果を返す前に、チャンク ID が一意であることを確認チェック。 そうでない場合、実装者はチャンクの番号を付け直し、新しいチャンク ID のマッピングを保持する必要があります。

要件

   
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー filter.h

関連項目

Ifilter

STAT_CHUNK