Share via

IFileSyncScopeFilter::GetFileAttributeExcludeMask

  • Article

Gets the attributes that are used to exclude files and folders from the scope.

HRESULT GetFileAttributeExcludeMask(
  DWORD *pdwFileAttributeExcludeMask);

Parameters

  • pdwFileAttributeExcludeMask
    [out] Returns the attributes that are used to exclude files and folders from the scope. The default value is 0.

Return Value

  • S_OK

  • E_POINTER

Remarks

A file or folder that has any one of the attributes included in this mask will be excluded from the synchronization scope.

If a folder is excluded, all its child files and folders are also excluded, even if the children do not have the attribute set directly on them. A value of 0 indicates an empty mask. This will exclude no files based on attributes.

The attributes are in the format used by the WIN32_FIND_DATA structure.

Sync Framework ignores certain attributes. An attribute that is ignored is treated as if it were set to 0 even if it is set to 1. The FSP_FILE_ATTRIBUTE_MASK constant in FileSyncProvider.h defines the following as valid attributes:

  • FILE_ATTRIBUTE_DIRECTORY

  • FILE_ATTRIBUTE_READONLY

  • FILE_ATTRIBUTE_HIDDEN

  • FILE_ATTRIBUTE_SYSTEM

  • FILE_ATTRIBUTE_TEMPORARY

See Also

Reference

IFileSyncScopeFilter Interface