IFileSyncScopeFilter::GetFilenameIncludes

スコープに明示的に含めるファイル名のコレクションを取得します。

構文

HRESULT GetFilenameIncludes(
  LPWSTR pszFilenameIncludes,
  ULONG *pcchLength);

パラメーター

• pszFilenameIncludes
  [in, out, unique, size_is(*pcchLength)] スコープに明示的に含まれるファイル名のセミコロン区切りの一覧を返します。この一覧に含まれていないファイルはスコープから除外されます。この値が空の文字列 " " の場合、スコープに明示的に含まれているファイルはありません。既定値は "*.*" です。

• pcchLength
  [in, out] pszFilenameIncludes の文字数を指定します。書き込まれた文字数を返します。pszFilenameIncludes が小さすぎる場合は、一覧を取得するのに必要な文字数を返します。

戻り値

• S_OK

• HRESULT_FROM_WIN32(ERROR_MORE_DATA) (pszFilenameIncludes が小さすぎる場合。この場合、必要な文字数が pcchLength に返されます。)

• E_OUTOFMEMORY

説明

ファイル名には、ワイルドカード (* および ?) を使用できます。

除外は、明示的な包含よりも優先されます。このため、ファイルまたはフォルダーが別のフィルターで除外されている場合は、この一覧に明示的に含まれていても、スコープから除外されます。

関連項目

その他の技術情報

IFileSyncScopeFilter インターフェイス