KF_REDIRECT_FLAGS enumeration
Flags used by IKnownFolderManager::Redirect to specify details of a known folder redirection such as permissions and ownership for the redirected folder.
Syntax
typedef enum _KF_REDIRECT_FLAGS { KF_REDIRECT_USER_EXCLUSIVE = 0x00000001, KF_REDIRECT_COPY_SOURCE_DACL = 0x00000002, KF_REDIRECT_OWNER_USER = 0x00000004, KF_REDIRECT_SET_OWNER_EXPLICIT = 0x00000008, KF_REDIRECT_CHECK_ONLY = 0x00000010, KF_REDIRECT_WITH_UI = 0x00000020, KF_REDIRECT_UNPIN = 0x00000040, KF_REDIRECT_PIN = 0x00000080, KF_REDIRECT_COPY_CONTENTS = 0x00000200, KF_REDIRECT_DEL_SOURCE_CONTENTS = 0x00000400, KF_REDIRECT_EXCLUDE_ALL_KNOWN_SUBFOLDERS = 0x00000800 } KF_REDIRECT_FLAGS;
Constants
- KF_REDIRECT_USER_EXCLUSIVE
-
Ensure that only the user has permission to access the redirected folder.
- KF_REDIRECT_COPY_SOURCE_DACL
-
Copy the DACL of the source folder to the target to maintain current access permissions.
- KF_REDIRECT_OWNER_USER
-
Sets the user as the owner of a newly created target folder unless the user is a member of the Administrator group, in which case Administrator is set as the owner. Must be called with KF_REDIRECT_SET_OWNER_EXPLICIT.
- KF_REDIRECT_SET_OWNER_EXPLICIT
-
Set the owner of a newly created target folder. If the user belongs to the Administrators group, Administrators is assigned as the owner. Must be called with KF_REDIRECT_OWNER_USER.
- KF_REDIRECT_CHECK_ONLY
-
Do not perform a redirection, simply check whether redirection has occurred. If so, IKnownFolderManager::Redirect returns S_OK; if not, or if some actions remain to be completed, it returns S_FALSE.
- KF_REDIRECT_WITH_UI
-
Display UI during the redirection.
- KF_REDIRECT_UNPIN
-
Unpin the source folder.
- KF_REDIRECT_PIN
-
Pin the target folder.
- KF_REDIRECT_COPY_CONTENTS
-
Copy the existing contents—both files and subfolders—of the known folder to the redirected folder.
- KF_REDIRECT_DEL_SOURCE_CONTENTS
-
Delete the contents of the source folder after they have been copied to the redirected folder. This flag is valid only if KF_REDIRECT_COPY_CONTENTS is set.
- KF_REDIRECT_EXCLUDE_ALL_KNOWN_SUBFOLDERS
-
Reserved. Do not use.
Remarks
The KF_REDIRECT_OWNER_USER and KF_REDIRECT_SET_OWNER_EXPLICIT flags provide ownership checks for the target folder, if that folder exists. By default, IKnownFolderManager::Redirect does not perform ownership checks. KF_REDIRECT_OWNER_USER and KF_REDIRECT_SET_OWNER_EXPLICIT are only valid if called together.
The KF_REDIRECT_FLAGS type is defined in Shobjidl.h as shown here.
typedef DWORD KF_REDIRECT_FLAGS;
Requirements
|
Minimum supported client | Windows Vista [desktop apps only] |
|---|---|
|
Minimum supported server | Windows Server 2008 [desktop apps only] |
|
Header |
|
|
IDL |
|
Send comments about this topic to Microsoft
Build date: 11/28/2012
