Top Description Inners Fields
com.sun.jna.platform.win32

public Interface ShlObj

Imports
com.sun.jna.platform.win32.WinDef.DWORD

Ported from ShlObj.h. Microsoft Windows SDK 6.0A.
Author
dblock[at]dblock.org

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
ShlObj.KNOWN_FOLDER_FLAG

KnownFolder flags as used by SHGetKnownFolderPath, SHGetKnownFolderIDList and others.

Field Summary

Modifier and TypeField and Description
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final WinDef.DWORD
public static final WinDef.DWORD

Field Detail

CSIDL_ADMINTOOLSback to summary
public static final int CSIDL_ADMINTOOLS
CSIDL_ALTSTARTUPback to summary
public static final int CSIDL_ALTSTARTUP
CSIDL_APPDATAback to summary
public static final int CSIDL_APPDATA
CSIDL_BITBUCKETback to summary
public static final int CSIDL_BITBUCKET
CSIDL_CDBURN_AREAback to summary
public static final int CSIDL_CDBURN_AREA
CSIDL_COMMON_ADMINTOOLSback to summary
public static final int CSIDL_COMMON_ADMINTOOLS
CSIDL_COMMON_ALTSTARTUPback to summary
public static final int CSIDL_COMMON_ALTSTARTUP
CSIDL_COMMON_APPDATAback to summary
public static final int CSIDL_COMMON_APPDATA
CSIDL_COMMON_DESKTOPDIRECTORYback to summary
public static final int CSIDL_COMMON_DESKTOPDIRECTORY
CSIDL_COMMON_DOCUMENTSback to summary
public static final int CSIDL_COMMON_DOCUMENTS
CSIDL_COMMON_FAVORITESback to summary
public static final int CSIDL_COMMON_FAVORITES
CSIDL_COMMON_MUSICback to summary
public static final int CSIDL_COMMON_MUSIC
CSIDL_COMMON_PICTURESback to summary
public static final int CSIDL_COMMON_PICTURES
CSIDL_COMMON_PROGRAMSback to summary
public static final int CSIDL_COMMON_PROGRAMS
CSIDL_COMMON_STARTMENUback to summary
public static final int CSIDL_COMMON_STARTMENU
CSIDL_COMMON_STARTUPback to summary
public static final int CSIDL_COMMON_STARTUP
CSIDL_COMMON_TEMPLATESback to summary
public static final int CSIDL_COMMON_TEMPLATES
CSIDL_COMMON_VIDEOback to summary
public static final int CSIDL_COMMON_VIDEO
CSIDL_COMPUTERSNEARMEback to summary
public static final int CSIDL_COMPUTERSNEARME
CSIDL_CONNECTIONSback to summary
public static final int CSIDL_CONNECTIONS
CSIDL_CONTROLSback to summary
public static final int CSIDL_CONTROLS
CSIDL_COOKIESback to summary
public static final int CSIDL_COOKIES
CSIDL_DESKTOPback to summary
public static final int CSIDL_DESKTOP
CSIDL_DESKTOPDIRECTORYback to summary
public static final int CSIDL_DESKTOPDIRECTORY
CSIDL_DRIVESback to summary
public static final int CSIDL_DRIVES
CSIDL_FAVORITESback to summary
public static final int CSIDL_FAVORITES
CSIDL_FONTSback to summary
public static final int CSIDL_FONTS
CSIDL_HISTORYback to summary
public static final int CSIDL_HISTORY
CSIDL_INTERNETback to summary
public static final int CSIDL_INTERNET
CSIDL_INTERNET_CACHEback to summary
public static final int CSIDL_INTERNET_CACHE
CSIDL_LOCAL_APPDATAback to summary
public static final int CSIDL_LOCAL_APPDATA
CSIDL_MYDOCUMENTSback to summary
public static final int CSIDL_MYDOCUMENTS
CSIDL_MYMUSICback to summary
public static final int CSIDL_MYMUSIC
CSIDL_MYPICTURESback to summary
public static final int CSIDL_MYPICTURES
CSIDL_MYVIDEOback to summary
public static final int CSIDL_MYVIDEO
CSIDL_NETHOODback to summary
public static final int CSIDL_NETHOOD
CSIDL_NETWORKback to summary
public static final int CSIDL_NETWORK
CSIDL_PERSONALback to summary
public static final int CSIDL_PERSONAL
CSIDL_PRINTERSback to summary
public static final int CSIDL_PRINTERS
CSIDL_PRINTHOODback to summary
public static final int CSIDL_PRINTHOOD
CSIDL_PROFILEback to summary
public static final int CSIDL_PROFILE
CSIDL_PROGRAM_FILESback to summary
public static final int CSIDL_PROGRAM_FILES
CSIDL_PROGRAM_FILES_COMMONback to summary
public static final int CSIDL_PROGRAM_FILES_COMMON
CSIDL_PROGRAM_FILES_COMMONX86back to summary
public static final int CSIDL_PROGRAM_FILES_COMMONX86
CSIDL_PROGRAM_FILESX86back to summary
public static final int CSIDL_PROGRAM_FILESX86
CSIDL_PROGRAMSback to summary
public static final int CSIDL_PROGRAMS
CSIDL_RECENTback to summary
public static final int CSIDL_RECENT
CSIDL_RESOURCESback to summary
public static final int CSIDL_RESOURCES
CSIDL_RESOURCES_LOCALIZEDback to summary
public static final int CSIDL_RESOURCES_LOCALIZED
CSIDL_SENDTOback to summary
public static final int CSIDL_SENDTO
CSIDL_STARTMENUback to summary
public static final int CSIDL_STARTMENU
CSIDL_STARTUPback to summary
public static final int CSIDL_STARTUP
CSIDL_SYSTEMback to summary
public static final int CSIDL_SYSTEM
CSIDL_SYSTEMX86back to summary
public static final int CSIDL_SYSTEMX86
CSIDL_TEMPLATESback to summary
public static final int CSIDL_TEMPLATES
CSIDL_WINDOWSback to summary
public static final int CSIDL_WINDOWS
SHGFP_TYPE_CURRENTback to summary
public static final WinDef.DWORD SHGFP_TYPE_CURRENT
SHGFP_TYPE_DEFAULTback to summary
public static final WinDef.DWORD SHGFP_TYPE_DEFAULT
com.sun.jna.platform.win32 back to summary

public final Enum ShlObj.KNOWN_FOLDER_FLAG

extends Enum<ShlObj.KNOWN_FOLDER_FLAG>
Class Inheritance

KnownFolder flags as used by SHGetKnownFolderPath, SHGetKnownFolderIDList and others. Microsoft Windows SDK 7.0A.

Field Summary

Modifier and TypeField and Description
public static final ShlObj.KNOWN_FOLDER_FLAG
ALIAS_ONLY

Introduced in Windows 7.

public static final ShlObj.KNOWN_FOLDER_FLAG
CREATE

Forces the creation of the specified folder if that folder does not already exist.

public static final ShlObj.KNOWN_FOLDER_FLAG
DEFAULT_PATH

Gets the default path for a known folder.

public static final ShlObj.KNOWN_FOLDER_FLAG
DONT_UNEXPAND

Stores the full path in the registry without using environment strings.

public static final ShlObj.KNOWN_FOLDER_FLAG
DONT_VERIFY

Do not verify the folder's existence before attempting to retrieve the path or IDList.

private int
public static final ShlObj.KNOWN_FOLDER_FLAG
INIT

Initializes the folder using its Desktop.ini settings.

public static final ShlObj.KNOWN_FOLDER_FLAG
NO_ALIAS

Gets the true system path for the folder, free of any aliased placeholders such as %USERPROFILE%, returned by SHGetKnownFolderIDList and IKnownFolder::GetIDList.

public static final ShlObj.KNOWN_FOLDER_FLAG
NO_APPCONTAINER_REDIRECTION

Introduced in Windows 7: When running inside an app container, or when providing an app container token, this flag prevents redirection to app container folders.

public static final ShlObj.KNOWN_FOLDER_FLAG
NONE

None

public static final ShlObj.KNOWN_FOLDER_FLAG
NOT_PARENT_RELATIVE

Gets the folder's default path independent of the current location of its parent.

public static final ShlObj.KNOWN_FOLDER_FLAG
SIMPLE_IDLIST

Build a simple IDList (PIDL) This value can be used when you want to retrieve the file system path but do not specify this value if you are retrieving the localized display name of the folder because it might not resolve correctly.

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public int
public static ShlObj.KNOWN_FOLDER_FLAG
public static ShlObj.KNOWN_FOLDER_FLAG[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

ALIAS_ONLYback to summary
public static final ShlObj.KNOWN_FOLDER_FLAG ALIAS_ONLY

Introduced in Windows 7. Return only aliased PIDLs. Do not use the file system path.

CREATEback to summary
public static final ShlObj.KNOWN_FOLDER_FLAG CREATE

Forces the creation of the specified folder if that folder does not already exist. The security provisions predefined for that folder are applied. If the folder does not exist and cannot be created, the function returns a failure code and no path is returned. This value can be used only with the following functions and methods:

  • SHGetKnownFolderPath
  • SHGetKnownFolderIDList
  • IKnownFolder::GetIDList
  • IKnownFolder::GetPath
  • IKnownFolder::GetShellItem
DEFAULT_PATHback to summary
public static final ShlObj.KNOWN_FOLDER_FLAG DEFAULT_PATH

Gets the default path for a known folder. If this flag is not set, the function retrieves the current-and possibly redirected-path of the folder. The execution of this flag includes a verification of the folder's existence unless KF_FLAG_DONT_VERIFY is set.

DONT_UNEXPANDback to summary
public static final ShlObj.KNOWN_FOLDER_FLAG DONT_UNEXPAND

Stores the full path in the registry without using environment strings. If this flag is not set, portions of the path may be represented by environment strings such as %USERPROFILE%. This flag can only be used with SHSetKnownFolderPath and IKnownFolder::SetPath.

DONT_VERIFYback to summary
public static final ShlObj.KNOWN_FOLDER_FLAG DONT_VERIFY

Do not verify the folder's existence before attempting to retrieve the path or IDList. If this flag is not set, an attempt is made to verify that the folder is truly present at the path. If that verification fails due to the folder being absent or inaccessible, the function returns a failure code and no path is returned. If the folder is located on a network, the function might take a longer time to execute. Setting this flag can reduce that lag time.

flagback to summary
private int flag
INITback to summary
public static final ShlObj.KNOWN_FOLDER_FLAG INIT

Initializes the folder using its Desktop.ini settings. If the folder cannot be initialized, the function returns a failure code and no path is returned. This flag should always be combined with KF_FLAG_CREATE.

NO_ALIASback to summary
public static final ShlObj.KNOWN_FOLDER_FLAG NO_ALIAS

Gets the true system path for the folder, free of any aliased placeholders such as %USERPROFILE%, returned by SHGetKnownFolderIDList and IKnownFolder::GetIDList. This flag has no effect on paths returned by SHGetKnownFolderPath and IKnownFolder::GetPath. By default, known folder retrieval functions and methods return the aliased path if an alias exists.

NO_APPCONTAINER_REDIRECTIONback to summary
public static final ShlObj.KNOWN_FOLDER_FLAG NO_APPCONTAINER_REDIRECTION

Introduced in Windows 7: When running inside an app container, or when providing an app container token, this flag prevents redirection to app container folders. Instead, it retrieves the path that would be returned where it not running inside an app container.

NONEback to summary
public static final ShlObj.KNOWN_FOLDER_FLAG NONE

None

NOT_PARENT_RELATIVEback to summary
public static final ShlObj.KNOWN_FOLDER_FLAG NOT_PARENT_RELATIVE

Gets the folder's default path independent of the current location of its parent. KF_FLAG_DEFAULT_PATH must also be set.

SIMPLE_IDLISTback to summary
public static final ShlObj.KNOWN_FOLDER_FLAG SIMPLE_IDLIST

Build a simple IDList (PIDL) This value can be used when you want to retrieve the file system path but do not specify this value if you are retrieving the localized display name of the folder because it might not resolve correctly.

Constructor Detail

KNOWN_FOLDER_FLAGback to summary
private KNOWN_FOLDER_FLAG(int flag)

Method Detail

getFlagback to summary
public int getFlag()
valueOfback to summary
public static ShlObj.KNOWN_FOLDER_FLAG valueOf(String name)
valuesback to summary
public static ShlObj.KNOWN_FOLDER_FLAG[] values()