com.jniwrapper.win32.shell
Interface IShellFolder

All Superinterfaces:
com.jniwrapper.AutoDeleteParameter, com.jniwrapper.win32.com.IUnknown
All Known Implementing Classes:
IShellFolderImpl

public interface IShellFolder
extends com.jniwrapper.win32.com.IUnknown

This interface is used to manage folders, and exposed by all Shell namespace folder objects.

See Also:
Microsoft Shell Interfaces documentation

Field Summary
static java.lang.String INTERFACE_IDENTIFIER
           
 
Method Summary
 com.jniwrapper.win32.com.impl.IUnknownImpl bindToObject(ItemIDList pidl, com.jniwrapper.win32.ole.IBindCtx pbc, com.jniwrapper.win32.com.types.GUID riid)
          Retrieves IShellFolder object for subfolder.
 com.jniwrapper.win32.com.impl.IUnknownImpl bindToStorage(ItemIDList pidl, com.jniwrapper.win32.ole.IBindCtx pbc, com.jniwrapper.win32.com.types.GUID riid)
          Requests pointer to object's storage interface.
 void compareIDs(com.jniwrapper.win32.com.types.LongPtr lParam, ItemIDList pidl1, ItemIDList pidl2)
          Determines the relative order of two file objects or folders, given their item identifier lists.
 com.jniwrapper.win32.com.impl.IUnknownImpl createViewObject(Wnd hwndOwner, com.jniwrapper.win32.com.types.GUID riid)
          Requests object that can be used to obtain information from or interact with a folder object.
 IEnumIDList enumObjects(Wnd hwnd, SHCONTF grfFlags)
          Allows a client to determine the contents of a folder by creating an item identifier enumeration object and returning its IEnumIDList interface.
 void getAttributesOf(com.jniwrapper.UInt cidl, com.jniwrapper.Pointer apidl, com.jniwrapper.UInt32 rgfInOut)
          Retrieves the attributes of one or more file or folder objects contained in the object represented by IShellFolder.
 STRRET getDisplayNameOf(ItemIDList pidl, com.jniwrapper.UInt32 uFlags)
          Retrieves display name for the specified file object or subfolder.
 void getUIObjectOf(Wnd hwndOwner, com.jniwrapper.UInt cidl, com.jniwrapper.Pointer apidl, com.jniwrapper.win32.com.types.GUID riid, com.jniwrapper.UInt rgfReserved, com.jniwrapper.Pointer.Void ppv)
          Retrieves OLE interface that can be used to carry out actions on the specified file objects or folders.
 void parseDisplayName(Wnd hwnd, com.jniwrapper.win32.ole.IBindCtx pbc, com.jniwrapper.win32.automation.types.BStr pszDisplayName, com.jniwrapper.UInt32 pchEaten, com.jniwrapper.Pointer ppidl, com.jniwrapper.UInt32 pdwAttributes)
          Translates display name of file object or folder into an item identifier list.
 com.jniwrapper.Pointer setNameOf(Wnd hwnd, ItemIDList pidl, com.jniwrapper.win32.automation.types.BStr pszName, com.jniwrapper.UInt32 uFlags)
          Sets the display name of a file object or subfolder.
 
Methods inherited from interface com.jniwrapper.win32.com.IUnknown
addRef, isNull, queryInterface, release, setNull
 
Methods inherited from interface com.jniwrapper.AutoDeleteParameter
isAutoDelete, setAutoDelete
 

Field Detail

INTERFACE_IDENTIFIER

public static final java.lang.String INTERFACE_IDENTIFIER
See Also:
Constant Field Values
Method Detail

parseDisplayName

public void parseDisplayName(Wnd hwnd,
                             com.jniwrapper.win32.ole.IBindCtx pbc,
                             com.jniwrapper.win32.automation.types.BStr pszDisplayName,
                             com.jniwrapper.UInt32 pchEaten,
                             com.jniwrapper.Pointer ppidl,
                             com.jniwrapper.UInt32 pdwAttributes)
                      throws com.jniwrapper.win32.com.ComException
Translates display name of file object or folder into an item identifier list.

Parameters:
hwnd -
pbc -
pszDisplayName -
pchEaten -
ppidl -
pdwAttributes -
Throws:
com.jniwrapper.win32.com.ComException

enumObjects

public IEnumIDList enumObjects(Wnd hwnd,
                               SHCONTF grfFlags)
                        throws com.jniwrapper.win32.com.ComException
Allows a client to determine the contents of a folder by creating an item identifier enumeration object and returning its IEnumIDList interface.

Parameters:
hwnd -
grfFlags -
Returns:
IEnumIDList
Throws:
com.jniwrapper.win32.com.ComException

bindToObject

public com.jniwrapper.win32.com.impl.IUnknownImpl bindToObject(ItemIDList pidl,
                                                               com.jniwrapper.win32.ole.IBindCtx pbc,
                                                               com.jniwrapper.win32.com.types.GUID riid)
                                                        throws com.jniwrapper.win32.com.ComException
Retrieves IShellFolder object for subfolder.

Parameters:
pidl -
pbc -
riid -
Returns:
Throws:
com.jniwrapper.win32.com.ComException

bindToStorage

public com.jniwrapper.win32.com.impl.IUnknownImpl bindToStorage(ItemIDList pidl,
                                                                com.jniwrapper.win32.ole.IBindCtx pbc,
                                                                com.jniwrapper.win32.com.types.GUID riid)
                                                         throws com.jniwrapper.win32.com.ComException
Requests pointer to object's storage interface.

Parameters:
pidl -
pbc -
riid -
Returns:
Throws:
com.jniwrapper.win32.com.ComException

compareIDs

public void compareIDs(com.jniwrapper.win32.com.types.LongPtr lParam,
                       ItemIDList pidl1,
                       ItemIDList pidl2)
                throws com.jniwrapper.win32.com.ComException
Determines the relative order of two file objects or folders, given their item identifier lists.

Parameters:
lParam -
pidl1 -
pidl2 -
Throws:
com.jniwrapper.win32.com.ComException

createViewObject

public com.jniwrapper.win32.com.impl.IUnknownImpl createViewObject(Wnd hwndOwner,
                                                                   com.jniwrapper.win32.com.types.GUID riid)
                                                            throws com.jniwrapper.win32.com.ComException
Requests object that can be used to obtain information from or interact with a folder object.

Parameters:
hwndOwner -
riid -
Returns:
Throws:
com.jniwrapper.win32.com.ComException

getAttributesOf

public void getAttributesOf(com.jniwrapper.UInt cidl,
                            com.jniwrapper.Pointer apidl,
                            com.jniwrapper.UInt32 rgfInOut)
                     throws com.jniwrapper.win32.com.ComException
Retrieves the attributes of one or more file or folder objects contained in the object represented by IShellFolder.

Parameters:
cidl -
apidl -
rgfInOut -
Throws:
com.jniwrapper.win32.com.ComException

getUIObjectOf

public void getUIObjectOf(Wnd hwndOwner,
                          com.jniwrapper.UInt cidl,
                          com.jniwrapper.Pointer apidl,
                          com.jniwrapper.win32.com.types.GUID riid,
                          com.jniwrapper.UInt rgfReserved,
                          com.jniwrapper.Pointer.Void ppv)
                   throws com.jniwrapper.win32.com.ComException
Retrieves OLE interface that can be used to carry out actions on the specified file objects or folders.

Parameters:
hwndOwner -
cidl -
apidl -
riid -
rgfReserved -
ppv -
Throws:
com.jniwrapper.win32.com.ComException

getDisplayNameOf

public STRRET getDisplayNameOf(ItemIDList pidl,
                               com.jniwrapper.UInt32 uFlags)
                        throws com.jniwrapper.win32.com.ComException
Retrieves display name for the specified file object or subfolder.

Parameters:
pidl -
uFlags -
Returns:
Throws:
com.jniwrapper.win32.com.ComException

setNameOf

public com.jniwrapper.Pointer setNameOf(Wnd hwnd,
                                        ItemIDList pidl,
                                        com.jniwrapper.win32.automation.types.BStr pszName,
                                        com.jniwrapper.UInt32 uFlags)
                                 throws com.jniwrapper.win32.com.ComException
Sets the display name of a file object or subfolder.

Parameters:
hwnd -
pidl -
pszName -
uFlags -
Returns:
Throws:
com.jniwrapper.win32.com.ComException