WdCopySearchOptions

コピー操作のファイルとディレクトリのフィルターパターンを指定します。 導入バージョン: RIT 0.0.8-Preview。メンバーの型と利用可否はリリースによって異なります。「変更履歴」を参照してください。

CopyFrom の場合、名前パターンはローカルの差分列挙にのみ影響し、リモートファイルの選択は制限しません。

構文

struct WdCopySearchOptions 
{ 
    const char* includeFilePattern;
    const char* excludeFilePattern;
    const char* excludeDirPattern;
    uint32_t includeFileAttributes;
    uint32_t excludeFileAttributes;
    uint32_t includeDirectoryAttributes;
    uint32_t excludeDirectoryAttributes;
};

メンバー

_In_z_ includeFilePattern
Type: const char* コピー操作に含めるファイルを指定する glob パターン (たとえば、すべてのファイルを含める場合は "*"、実行可能ファイルと DLL のみを含める場合は "*.exe;*.dll")。 _In_z_ excludeFilePattern
Type: const char* コピー操作から除外するファイルを指定する glob パターン (たとえば、デバッグシンボルを除外する場合は "*.pdb")。 _In_z_ excludeDirPattern
Type: const char* コピー操作から除外するディレクトリの名前 (パスではありません) を指定する glob パターン (たとえば、Visual Studio とビルド出力のディレクトリを除外する場合は ".vs;obj")。 includeFileAttributes
Type: uint32_t ファイル属性のビットマスク。指定した属性のいずれかを持つファイルがコピーに含まれます。属性でフィルター処理しない場合は 0 に設定します。ファイル属性の詳細については、「File Attribute Constants」を参照してください。 excludeFileAttributes
Type: uint32_t ファイルをコピーから除外する原因となるファイル属性のビットマスク。属性でフィルター処理しない場合は 0 に設定します。ファイル属性の詳細については、「File Attribute Constants」を参照してください。 includeDirectoryAttributes
Type: uint32_t 導入バージョン: RIT 0.0.13-preview。ディレクトリ属性のビットマスク。指定した属性のいずれかを持つディレクトリがコピーに含まれます。これは、includeFileAttributes をディレクトリに適用したものと同じです。属性でフィルター処理しない場合は 0 に設定します。 excludeDirectoryAttributes
Type: uint32_t 導入バージョン: RIT 0.0.13-preview。ディレクトリをコピーから除外する原因となるディレクトリ属性のビットマスク。これは、excludeFileAttributes をディレクトリに適用したものと同じです。属性でフィルター処理しない場合は 0 に設定します。

例

以下の名前パターンの例では CopyTo を使用しています。 .exe ファイルと .dll ファイルのみをコピーする:

WdCopySearchOptions searchOptions = {
    .includeFilePattern = "*.exe;*.dll",
    .excludeFilePattern = nullptr,
    .excludeDirPattern = nullptr,
    .includeFileAttributes = 0,
    .excludeFileAttributes = 0,
    .includeDirectoryAttributes = 0,
    .excludeDirectoryAttributes = 0
};

temp という名前のディレクトリをコピーから除外する:

WdCopySearchOptions searchOptions = {
    .includeFilePattern = nullptr,
    .excludeFilePattern = nullptr,
    .excludeDirPattern = "temp",
    .includeFileAttributes = 0,
    .excludeFileAttributes = 0,
    .includeDirectoryAttributes = 0,
    .excludeDirectoryAttributes = 0
};

読み取り専用ファイルまたはシステムファイルのみをコピーし、隠しファイルを除外する:

WdCopySearchOptions searchOptions = {
    .includeFilePattern = nullptr,
    .excludeFilePattern = nullptr,
    .excludeDirPattern = nullptr,
    .includeFileAttributes = FILE_ATTRIBUTE_READONLY | FILE_ATTRIBUTE_SYSTEM,
    .excludeFileAttributes = FILE_ATTRIBUTE_HIDDEN,
    .includeDirectoryAttributes = 0,
    .excludeDirectoryAttributes = 0
};

隠しディレクトリのみを無視する:

WdCopySearchOptions searchOptions = {
    .includeFilePattern = nullptr,
    .excludeFilePattern = nullptr,
    .excludeDirPattern = nullptr,
    .includeFileAttributes = 0,
    .excludeFileAttributes = 0,
    .includeDirectoryAttributes = 0,
    .excludeDirectoryAttributes = FILE_ATTRIBUTE_HIDDEN
};

包含パターンと除外パターンが競合する場合は、除外パターンが優先され、ファイルはコピーされません。

解説

コピー操作に含めるファイルとディレクトリをフィルター処理するには、この構造体を searchOptions パラメーターを介して WdRemoteCopy に渡します。searchOptions に nullptr を渡した場合は、フィルター処理なしですべてのファイルがコピーされます。

変更履歴

リリース	変更内容
RIT 0.0.13-preview	`includeFileAttributes` と `excludeFileAttributes` を `uint64_t` から `uint32_t` に変更しました。`includeDirectoryAttributes` と `excludeDirectoryAttributes` (どちらも `uint32_t`) を追加しました。
RIT 0.0.8-Preview	3 つの名前パターンフィールドと 2 つの `uint64_t` ファイル属性マスクを導入しました。

RIT 0.0.13-preview の変更により、構造体のレイアウトが変わります。ネイティブの呼び出し元は、対応する API NuGet パッケージのヘッダーとライブラリを使用して再ビルドしてください。古い構造体レイアウトを新しい API DLL に渡さないでください。

要件

要件	値
ヘッダー	WdRemoteIteration.h
ライブラリ	wdremoteapi.lib
サポートされている OS	Windows 11 以降
サポートされているアーキテクチャ	x64、ARM64

(all) API references

Error codes

Audio API reference

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

WdCopySearchOptions

WdCopySearchOptions

構文

メンバー

例

解説

変更履歴

要件

関連項目

​WdCopySearchOptions

​構文

​メンバー

​例

​解説

​変更履歴

​要件

​関連項目

WdCopySearchOptions

構文

メンバー

例

解説

変更履歴

要件

関連項目