2.2.1.8.1 Element-Specific Attributes

Attribute name

Description

action

(optional) If specified, the value MUST be C, D, R, or U, corresponding to Create, Delete, Replace, and Update. If unspecified, the default value is U.

  • Create: This action MUST be used to create a new folder for computers or users. If the folder already exists, then a new folder MUST NOT be created, and an error MUST NOT be returned.

  • Delete: This action MUST be used to remove a folder for computers or users. If the folder does not exist, then the client MUST NOT perform an action, and an error MUST NOT be returned.

  • Replace: This action MUST be used to delete and re-create a folder for computers or users. The net result of the Replace action MUST be to delete the contents of an existing folder and to overwrite all existing settings associated with the folder. If the folder does not exist, then the Replace action MUST create a new folder.

  • Update: This action MUST be used to modify an existing folder for computers or users. This action differs from Replace in that it MUST update only settings defined within the preference item. All other settings remain as configured on the folder. If the folder does not exist, then the Update action MUST create a new folder.

path

MUST be a fully qualified UNC path to the folder from the perspective of the client. The path MUST NOT include quotation marks or a trailing slash. Text delimited by the percent sign (%) SHOULD be considered a system or user environment variable and clients SHOULD attempt to expand the environment variable as defined in section 2.2.1.5.

readonly

MUST be 1 to set the read-only attribute on the file, or 0 to clear the attribute.

archive

MUST be 1 to set the archive attribute on the file, or 0 to clear the attribute.

hidden

MUST be 1 to set the hidden attribute on the file, or 0 to clear the attribute.

deleteIgnoreErrors

(optional) MUST be 0 or 1. If 0, then the client logs an error, using implementation-dependent means, if the Folder item attempts to delete a folder that is not empty, a file that is open, a file or folder for which the user does not have permission, or any other file or folder that cannot be deleted. If 1, the client does not log such errors.

deleteReadOnly

(optional) MUST be 0 or 1. If this option is set to 0, read-only files and folders MUST NOT be deleted. If set to 1, the read-only attribute of files and folders that this Folder item attempts to delete MUST be cleared so that the files can be deleted.

deleteFiles

(optional) MUST be 0 or 1. If this option is set to 0, files within folders MUST NOT be deleted. If set to 1, all files within a folder that are allowed to be deleted MUST be deleted.

deleteSubFolders

(optional) MUST be 0 or 1. If this option is set to 0, subfolders within the folder MUST NOT be deleted. If this option is set to 1, the lowest level of subfolders MUST be deleted if they are empty, repeating for each parent folder until reaching the folder specified in the Path field. If the deleteFiles attribute is also set, the client MUST process it before processing deleteSubFolders.

deleteFolder

(optional) MUST be 0 or 1. If this option is set to 0, the folder specified in the Path field MUST NOT be deleted. If this option is set to 1, the folder specified in the Path field MUST be deleted if it is empty. If the deleteFiles and/or deleteSubFolders attributes are also set, the client MUST process them before processing deleteFolder.

The three attributes deleteFiles, deleteSubFolders, and deleteFolder MUST be processed by the client in that order, such that if all three are specified and set to 1, all files will be deleted, all empty subfolders will be deleted, and finally, if empty, the last parent folder will be deleted.