Edit

_KF_DEFINITION_FLAGS enumeration (shobjidl_core.h)

  • Article

Flags that specify certain known folder behaviors. Used with the KNOWNFOLDER_DEFINITION structure.

Syntax

typedef enum _KF_DEFINITION_FLAGS {
  KFDF_LOCAL_REDIRECT_ONLY = 0x2,
  KFDF_ROAMABLE = 0x4,
  KFDF_PRECREATE = 0x8,
  KFDF_STREAM = 0x10,
  KFDF_PUBLISHEXPANDEDPATH = 0x20,
  KFDF_NO_REDIRECT_UI = 0x40
} ;

Constants

 
KFDF_LOCAL_REDIRECT_ONLY
Value: 0x2
Prevent a per-user known folder from being redirected to a network location. Note that if the known folder has been flagged with KFDF_LOCAL_REDIRECT_ONLY but it is a subfolder of a known folder that is redirected to a network location, this subfolder is redirected also.
KFDF_ROAMABLE
Value: 0x4
Can be roamed through a PC-to-PC synchronization.
KFDF_PRECREATE
Value: 0x8
Create the folder when the user first logs on. Normally a known folder is not created until it is first called. At that time, an API such as SHCreateItemInKnownFolder or IKnownFolder::GetShellItem is called with the KF_FLAG_CREATE flag. However, some known folders need to exist immediately. An example is those known folders under %USERPROFILE%, which must exist to provide a proper view. In those cases, KFDF_PRECREATE is set and Windows Explorer calls the creation API during its user initialization.
KFDF_STREAM
Value: 0x10
Introduced in Windows 7. The known folder is a file rather than a folder.
KFDF_PUBLISHEXPANDEDPATH
Value: 0x20
Introduced in Windows 7. The full path of the known folder, with any environment variables fully expanded, is stored in the registry under HKEY_CURRENT_USER.
KFDF_NO_REDIRECT_UI
Value: 0x40
Introduced in Windows 8.1. Prevent showing the Locations tab in the property dialog of the known folder.

Remarks

The KF_DEFINITION_FLAGS type is defined in Shobjidl.h as shown here.

typedef DWORD KF_DEFINITION_FLAGS;

Requirements

Requirement Value
Minimum supported client Windows Vista, Windows 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Header shobjidl_core.h (include Shobjidl.h)

See also

Known Folders Sample