WdCopySearchOptions

Specifies file and directory filter patterns for a copy operation.

Syntax

struct WdCopySearchOptions 
{ 
    const char* includeFilePattern;
    const char* excludeFilePattern;
    const char* excludeDirPattern;
    uint64_t includeFileAttributes;
    uint64_t excludeFileAttributes;
};

Members

_In_z_ includeFilePattern
Type: const char* A glob pattern specifying which files to include in the copy operation (for example, "*" to include all files, or "*.exe;*.dll" to include only executables and DLLs). _In_z_ excludeFilePattern
Type: const char* A glob pattern specifying which files to exclude from the copy operation (for example, "*.pdb" to exclude debug symbols). _In_z_ excludeDirPattern
Type: const char* A glob pattern specifying which directories to exclude from the copy operation (for example, ".vs;obj" to exclude Visual Studio and build output directories). includeFileAttributes
Type: uint64_t A bitmask of file attributes that files must have to be included in the copy. Set to 0 to not filter by attributes. For additional information on file attributes check File Attribute Constants. excludeFileAttributes
Type: uint64_t A bitmask of file attributes that cause files to be excluded from the copy. Set to 0 to not filter by attributes. For additional information on file attributes check File Attribute Constants.

Examples

Copy only .exe and .dll files:

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

Exclude directories named temp from the copy:

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

Only copy read-only or system files, and exclude hidden files:

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

When there is a conflict between include and exclude patterns, the exclude pattern takes precedence and the file will not be copied.

Remarks

Pass this structure to WdRemoteCopy via the searchOptions parameter to filter which files and directories are included in the copy operation. If nullptr is passed for searchOptions, all files are copied with no filtering.

Requirements

Requirement	Value
Header	WdRemoteIteration.h
Library	wdremoteapi.lib
Supported OS	Windows 11 and later
Supported architectures	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

Syntax

Members

Examples

Remarks

Requirements

See also

​WdCopySearchOptions

​Syntax

​Members

​Examples

​Remarks

​Requirements

​See also

WdCopySearchOptions

Syntax

Members

Examples

Remarks

Requirements

See also