WdDeleteOptions
Specifies options for a delete operation on a remote device. Introduced in: RIT 0.0.13-preview.Syntax
Members
commonRootAliasType: const char* An optional alias for a common root location on the remote device (UTF-8). Set to
nullptr to use the default common root location.
deleteRootFolderType: bool When
true, removal of the remoteFolderPath folder itself is attempted once its contents have been deleted, but only if it is left empty. A filtered delete that leaves items behind preserves the folder. When false, which is the default, only the contents of remoteFolderPath are deleted and the folder itself is left in place. This field is ignored when remoteFolderPath resolves to a single file.
This field controls only removal of remoteFolderPath itself. Regardless of its value, the operation attempts to remove empty subdirectories that pass the directory filters, including directories that were already empty.
Remarks
Pass this structure to WdDeleteRemoteFiles via thedeleteOptions parameter. If nullptr is passed for deleteOptions, the default common root location is used when remoteFolderPath is a relative path, and only the contents of the folder are deleted.
Deletion is best effort. A successful return from WdDeleteRemoteFiles does not guarantee that every selected item or the root folder was removed.
If remoteFolderPath is an absolute path, commonRootAlias is ignored. If remoteFolderPath is a relative path, it is resolved against the common root identified by the alias, or against the default common root location when no alias is specified.