public interface Shell32 extends ShellAPI, StdCallLibrary
ShellAPI.APPBARDATA, ShellAPI.SHELLEXECUTEINFO, ShellAPI.SHFILEOPSTRUCTStdCallLibrary.StdCallCallbackLibrary.Handler| Modifier and Type | Field and Description |
|---|---|
static Shell32 |
INSTANCE
The instance
|
static int |
SEE_MASK_FLAG_NO_UI
Do not display an error message box if an error occurs.
|
static int |
SEE_MASK_NOCLOSEPROCESS
SEE_MASK_NOCLOSEPROCESS (0x00000040)
Use to indicate that the hProcess member receives the
process handle.
|
static int |
SHERB_NOCONFIRMATION
No dialog box confirming the deletion of the objects will be displayed.
|
static int |
SHERB_NOPROGRESSUI
No dialog box indicating the progress will be displayed.
|
static int |
SHERB_NOSOUND
No sound will be played when the operation is complete.
|
ABE_BOTTOM, ABE_LEFT, ABE_RIGHT, ABE_TOP, ABM_ACTIVATE, ABM_GETAUTOHIDEBAR, ABM_GETSTATE, ABM_GETTASKBARPOS, ABM_NEW, ABM_QUERYPOS, ABM_REMOVE, ABM_SETAUTOHIDEBAR, ABM_SETPOS, ABM_SETSTATE, ABM_WINDOWPOSCHANGED, FO_COPY, FO_DELETE, FO_MOVE, FO_RENAME, FOF_ALLOWUNDO, FOF_CONFIRMMOUSE, FOF_FILESONLY, FOF_MULTIDESTFILES, FOF_NO_CONNECTED_ELEMENTS, FOF_NO_UI, FOF_NOCONFIRMATION, FOF_NOCONFIRMMKDIR, FOF_NOCOPYSECURITYATTRIBS, FOF_NOERRORUI, FOF_NORECURSEREPARSE, FOF_NORECURSION, FOF_RENAMEONCOLLISION, FOF_SILENT, FOF_SIMPLEPROGRESS, FOF_WANTMAPPINGHANDLE, FOF_WANTNUKEWARNING, PO_DELETE, PO_PORTCHANGE, PO_REN_PORT, PO_RENAME, STRUCTURE_ALIGNMENT, TYPE_MAPPERFUNCTION_MAPPER, STDCALL_CONVENTIONOPTION_ALLOW_OBJECTS, OPTION_CALLING_CONVENTION, OPTION_CLASSLOADER, OPTION_FUNCTION_MAPPER, OPTION_INVOCATION_MAPPER, OPTION_OPEN_FLAGS, OPTION_STRING_ENCODING, OPTION_STRUCTURE_ALIGNMENT, OPTION_TYPE_MAPPER| Modifier and Type | Method and Description |
|---|---|
int |
ExtractIconEx(String lpszFile,
int nIconIndex,
WinDef.HICON[] phiconLarge,
WinDef.HICON[] phiconSmall,
int nIcons) |
WinNT.HRESULT |
GetCurrentProcessExplicitAppUserModelID(PointerByReference ppszAppID)
Retrieves the application-defined, explicit Application User Model ID (AppUserModelID) for the current process.
|
WinNT.HRESULT |
SetCurrentProcessExplicitAppUserModelID(WString appID)
Specifies a unique application-defined Application User Model ID (AppUserModelID) that identifies the current process to the taskbar.
|
WinDef.UINT_PTR |
SHAppBarMessage(WinDef.DWORD dwMessage,
ShellAPI.APPBARDATA pData)
SHAppBarMessage function
|
WinDef.INT_PTR |
ShellExecute(WinDef.HWND hwnd,
String lpOperation,
String lpFile,
String lpParameters,
String lpDirectory,
int nShowCmd)
Performs an operation on a specified file.
|
boolean |
ShellExecuteEx(ShellAPI.SHELLEXECUTEINFO lpExecInfo) |
int |
SHEmptyRecycleBin(WinNT.HANDLE hwnd,
String pszRootPath,
int dwFlags)
Empties the Recycle Bin on the specified drive.
|
int |
SHFileOperation(ShellAPI.SHFILEOPSTRUCT fileop)
This function can be used to copy, move, rename, or delete a file system object.
|
WinNT.HRESULT |
SHGetDesktopFolder(PointerByReference ppshf)
Retrieves the IShellFolder interface for the desktop folder, which is the root of the Shell's namespace.
|
WinNT.HRESULT |
SHGetFolderPath(WinDef.HWND hwndOwner,
int nFolder,
WinNT.HANDLE hToken,
WinDef.DWORD dwFlags,
char[] pszPath)
Takes the CSIDL of a folder and returns the path.
|
WinNT.HRESULT |
SHGetKnownFolderPath(Guid.GUID rfid,
int dwFlags,
WinNT.HANDLE hToken,
PointerByReference ppszPath)
Retrieves the full path of a known folder identified by the folder's KNOWNFOLDERID.
|
WinNT.HRESULT |
SHGetSpecialFolderLocation(WinDef.HWND hwndOwner,
int nFolder,
PointerByReference ppidl)
SHGetSpecialFolderLocation function for getting PIDL reference to My Computer etc
|
boolean |
SHGetSpecialFolderPath(WinDef.HWND owner,
char[] path,
int csidl,
boolean create)
Retrieves the path of a special folder, identified by its CSIDL.
|
static final Shell32 INSTANCE
static final int SHERB_NOCONFIRMATION
static final int SHERB_NOPROGRESSUI
static final int SHERB_NOSOUND
static final int SEE_MASK_NOCLOSEPROCESS
SEE_MASK_NOCLOSEPROCESS (0x00000040)
Use to indicate that the hProcess member receives the process handle. This handle is typically used to allow an application to find out when a process created with terminates. In some cases, such as when execution is satisfied through a DDE conversation, no handle will be returned. The calling application is responsible for closing the handle when it is no longer needed.
static final int SEE_MASK_FLAG_NO_UI
int SHFileOperation(ShellAPI.SHFILEOPSTRUCT fileop)
fileop - Address of an SHFILEOPSTRUCT structure that contains information this function
needs to carry out the specified operation.WinNT.HRESULT SHGetFolderPath(WinDef.HWND hwndOwner, int nFolder, WinNT.HANDLE hToken, WinDef.DWORD dwFlags, char[] pszPath)
hwndOwner - Handle to an owner window. This parameter is typically set to NULL. If it is not NULL,
and a dial-up connection needs to be made to access the folder, a user interface (UI)
prompt will appear in this window.nFolder - A CSIDL value that identifies the folder whose path is to be retrieved. Only real
folders are valid. If a virtual folder is specified, this function will fail. You can
force creation of a folder with SHGetFolderPath by combining the folder's CSIDL with
CSIDL_FLAG_CREATE.hToken - An access token that can be used to represent a particular user.dwFlags - Flags to specify which path is to be returned.pszPath - Pointer to a null-terminated string of length MAX_PATH which will receive the path.
If an error occurs or S_FALSE is returned, this string will be empty.WinNT.HRESULT SHGetKnownFolderPath(Guid.GUID rfid, int dwFlags, WinNT.HANDLE hToken, PointerByReference ppszPath)
SHGetFolderPath(com.sun.jna.platform.win32.WinDef.HWND, int, com.sun.jna.platform.win32.WinNT.HANDLE, com.sun.jna.platform.win32.WinDef.DWORD, char[]). That older function is now simply a wrapper for SHGetKnownFolderPath.rfid - A reference to the KNOWNFOLDERID (in KnownFolders) that identifies the folder.dwFlags - Flags that specify special retrieval options. This value can be 0; otherwise, one or more of the
ShlObj.KNOWN_FOLDER_FLAG values.hToken - Type: HANDLE An access token that represents a particular user. If this parameter is NULL, which is
the most common usage, the function requests the known folder for the current user. Request a specific user's
folder by passing the hToken of that user. This is typically done in the context of a service that has sufficient
privileges to retrieve the token of a given user. That token must be opened with TOKEN_QUERY and
TOKEN_IMPERSONATE rights. In some cases, you also need to include TOKEN_DUPLICATE. In addition to passing the
user's hToken, the registry hive of that specific user must be mounted. See Access Control for further discussion
of access control issues. Assigning the hToken parameter a value of -1 indicates the Default User. This allows
clients of SHGetKnownFolderPath to find folder locations (such as the Desktop folder) for the Default User. The
Default User user profile is duplicated when any new user account is created, and includes special folders such
as Documents and Desktop. Any items added to the Default User folder also appear in any new user account. Note
that access to the Default User folders requires administrator privileges.ppszPath - When this method returns, contains the address of a pointer to a null-terminated
Unicode string that specifies the path of the known folder. The calling process is responsible for freeing this
resource once it is no longer needed by calling Ole32.CoTaskMemFree(com.sun.jna.Pointer). The returned path does not include a trailing
backslash. For example, "C:\Users" is returned rather than "C:\Users\".WinNT.HRESULT SHGetDesktopFolder(PointerByReference ppshf)
ppshf - A place to put the IShellFolder interface pointerWinDef.INT_PTR ShellExecute(WinDef.HWND hwnd, String lpOperation, String lpFile, String lpParameters, String lpDirectory, int nShowCmd)
hwnd - A handle to the owner window used for displaying a UI or error messages. This value can be NULL if the
operation is not associated with a window.lpOperation - A pointer to a null-terminated string, referred to in this case as a verb, that specifies the action to be
performed. The set of available verbs depends on the particular file or folder. Generally, the actions
available from an object's shortcut menu are available verbs. The following verbs are commonly used:
edit
Launches an editor and opens the document for editing. If lpFile is not a document file, the function will
fail.
explore
Explores a folder specified by lpFile.
find
Initiates a search beginning in the directory specified by lpDirectory.
open
Opens the item specified by the lpFile parameter. The item can be a file or folder.
print
Prints the file specified by lpFile. If lpFile is not a document file, the function fails.
NULL
In systems prior to Windows 2000, the default verb is used if it is valid and available in the registry. If
not, the "open" verb is used.
In Windows 2000 and later, the default verb is used if available. If not, the "open" verb is used. If neither
verb is available, the system uses the first verb listed in the registry.lpFile - A pointer to a null-terminated string that specifies the file or object on which to execute the specified verb.
To specify a Shell namespace object, pass the fully qualified parse name. Note that not all verbs are supported
on all objects. For example, not all document types support the "print" verb. If a relative path is used for
the lpDirectory parameter do not use a relative path for lpFile.lpParameters - If lpFile specifies an executable file, this parameter is a pointer to a null-terminated string that specifies
the parameters to be passed to the application. The format of this string is determined by the verb that is to
be invoked. If lpFile specifies a document file, lpParameters should be NULL.lpDirectory - A pointer to a null-terminated string that specifies the default (working) directory for the action. If this
value is NULL, the current working directory is used. If a relative path is provided at lpFile, do not use a
relative path for lpDirectory.nShowCmd - The flags that specify how an application is to be displayed when it is opened. If lpFile specifies a document
file, the flag is simply passed to the associated application. It is up to the application to decide how to
handle it.WinDef.INT_PTR is used instead of HINSTANCE here, since
the former fits the reutrn type's actual usage more closely.
0 The operating system is out of memory or resources.
ERROR_FILE_NOT_FOUND The specified file was not found.
ERROR_PATH_NOT_FOUND The specified path was not found.
ERROR_BAD_FORMAT The .exe file is invalid (non-Win32 .exe or error in .exe image).
SE_ERR_ACCESSDENIED The operating system denied access to the specified file.
SE_ERR_ASSOCINCOMPLETE The file name association is incomplete or invalid.
SE_ERR_DDEBUSY The DDE transaction could not be completed because other DDE transactions were being processed.
SE_ERR_DDEFAIL The DDE transaction failed.
SE_ERR_DDETIMEOUT The DDE transaction could not be completed because the request timed out.
SE_ERR_DLLNOTFOUND The specified DLL was not found.
SE_ERR_FNF The specified file was not found.
SE_ERR_NOASSOC There is no application associated with the given file name extension. This error will also be
returned if you attempt to print a file that is not printable.
SE_ERR_OOM There was not enough memory to complete the operation.
SE_ERR_PNF The specified path was not found.
SE_ERR_SHARE A sharing violation occurred.boolean SHGetSpecialFolderPath(WinDef.HWND owner, char[] path, int csidl, boolean create)
owner - Reserved.path - A pointer to a null-terminated string that receives the drive and path of the specified folder. This buffer must be at least MAX_PATH
characters in size.csidl - A CSIDL that identifies the folder of interest. If a virtual folder is specified, this function will fail.create - Indicates whether the folder should be created if it does not already exist. If this value is nonzero, the folder is created. If this value is
zero, the folder is not created.true if successful; otherwise, false.WinDef.UINT_PTR SHAppBarMessage(WinDef.DWORD dwMessage, ShellAPI.APPBARDATA pData)
dwMessage - Appbar message value to send. This parameter can be one of the following values.
ShellAPI.ABM_NEW Registers a new appbar and specifies the message identifier that the system should use to send notification messages to the appbar.
ShellAPI.ABM_REMOVE Unregisters an appbar, removing the bar from the system's internal list.
ShellAPI.ABM_QUERYPOS Requests a size and screen position for an appbar.
ShellAPI.ABM_SETPOS Sets the size and screen position of an appbar.
ShellAPI.ABM_GETSTATE Retrieves the autohide and always-on-top states of the Windows taskbar.
ShellAPI.ABM_GETTASKBARPOS Retrieves the bounding rectangle of the Windows taskbar. Note that this applies only to the system taskbar. Other objects, particularly toolbars supplied with third-party software, also can be present. As a result, some of the screen area not covered by the Windows taskbar might not be visible to the user. To retrieve the area of the screen not covered by both the taskbar and other app bars -- the working area available to your application --, use the GetMonitorInfo function.
ShellAPI.ABM_ACTIVATE Notifies the system to activate or deactivate an appbar. The lParam member of the APPBARDATA pointed to by pData is set to TRUE to activate or FALSE to deactivate.
ShellAPI.ABM_GETAUTOHIDEBAR Retrieves the handle to the autohide appbar associated with a particular edge of the screen.
ShellAPI.ABM_SETAUTOHIDEBAR Registers or unregisters an autohide appbar for an edge of the screen.
ShellAPI.ABM_WINDOWPOSCHANGED Notifies the system when an appbar's position has changed.
ShellAPI.ABM_SETSTATE Windows XP and later: Sets the state of the appbar's autohide and always-on-top attributes.pData - A pointer to an APPBARDATA structure. The content of the structure on entry and on exit depends on the value set in the dwMessage parameter. See the individual message pages for specifics.int SHEmptyRecycleBin(WinNT.HANDLE hwnd, String pszRootPath, int dwFlags)
hwnd - A handle to the parent window of any dialog boxes that might
be displayed during the operation.pszRootPath - a null-terminated string of maximum length MAX_PATH that
contains the path of the rootdwFlags - a bitwise combination of SHERB_NOCONFIRMATION,
SHERB_NOPROGRESSUI and SHERB_NOSOUND.boolean ShellExecuteEx(ShellAPI.SHELLEXECUTEINFO lpExecInfo)
lpExecInfo - Type: SHELLEXECUTEINFO*
A pointer to a SHELLEXECUTEINFO structure that contains and receives information about the application being executed.
Returns TRUE if successful; otherwise, FALSE. Call GetLastError for extended error information.
WinNT.HRESULT SHGetSpecialFolderLocation(WinDef.HWND hwndOwner, int nFolder, PointerByReference ppidl)
hwndOwner - Reserved.nFolder - A CSIDL value that identifies the folder of interest.ppidl - A PIDL specifying the folder's location relative to the root of the namespace (the desktop). It is the responsibility of the calling application to free the returned IDList by using CoTaskMemFree.int ExtractIconEx(String lpszFile, int nIconIndex, WinDef.HICON[] phiconLarge, WinDef.HICON[] phiconSmall, int nIcons)
lpszFile - Type: LPCTSTRnIconIndex - Type: intphiconLarge - Type: HICON*phiconSmall - Type: HICON*nIcons - Type: UINTWinNT.HRESULT GetCurrentProcessExplicitAppUserModelID(PointerByReference ppszAppID)
ppszAppID - A pointer that receives the address of the AppUserModelID assigned to the process. The caller is responsible for freeing this string with Ole32.CoTaskMemFree(com.sun.jna.Pointer) when it is no longer needed.WinNT.HRESULT SetCurrentProcessExplicitAppUserModelID(WString appID)
appID - The AppUserModelID to assign to the current process.