com.jniwrapper.win32.shell
Interface IShellLink

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

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

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

See Also:
Microsoft IShellLink Interface

Field Summary
static java.lang.String INTERFACE_IDENTIFIER
          String representation of the IID of the IShellLink interface
 
Method Summary
 com.jniwrapper.Str getArguments(com.jniwrapper.Int cch)
          Returns the command-line arguments associated with a Shell link object.
 com.jniwrapper.Str getDescription(com.jniwrapper.Int cch)
          Returns the description string for a Shell link object.
 com.jniwrapper.UInt16 getHotkey()
          Returns the keyboard shortcut (hot key) for a Shell link object.
 void getIconLocation(com.jniwrapper.Str pszIconPath, com.jniwrapper.Int cch, com.jniwrapper.Int piIcon)
          Returns the location (path and index) of the icon for a Shell link object.
 ItemIDList getIDList()
          Returns the list of item identifiers for a Shell link object.
 void getPath(com.jniwrapper.Str pszFile, com.jniwrapper.Int cch, Win32FindData pfd, com.jniwrapper.UInt32 fFlags)
          Returns the path and file name of a Shell link object.
 com.jniwrapper.Int getShowCmd()
          Returns the show command for a Shell link object.
 com.jniwrapper.Str getWorkingDirectory(com.jniwrapper.Int cch)
          Returns the name of the working directory for a Shell link object.
 void resolve(Wnd hwnd, com.jniwrapper.UInt32 fFlags)
          Attempts to find the target of a Shell link, even if it has been moved or renamed.
 void setArguments(com.jniwrapper.Str pszArgs)
          Sets the command-line arguments for a Shell link object.
 void setDescription(com.jniwrapper.Str pszName)
          Sets the description for a Shell link object.
 void setHotkey(com.jniwrapper.UInt16 wHotkey)
          Sets a keyboard shortcut (hot key) for a Shell link object.
 void setIconLocation(com.jniwrapper.Str pszIconPath, com.jniwrapper.Int iIcon)
          Sets the location (path and index) of the icon for a Shell link object.
 void setIDList(ItemIDList pidl)
          Sets the pointer to an item identifier list (PIDL) for a Shell link object
 void setPath(com.jniwrapper.Str pszFile)
          Sets the path and file name of a Shell link object.
 void setRelativePath(com.jniwrapper.Str pszPathRel, com.jniwrapper.UInt32 dwReserved)
          Sets the relative path to the Shell link object.
 void setShowCmd(com.jniwrapper.Int iShowCmd)
          Sets the show command for a Shell link object.
 void setWorkingDirectory(com.jniwrapper.Str pszDir)
          Sets the name of the working directory for a Shell link object.
 
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
String representation of the IID of the IShellLink interface

Method Detail

getPath

public void getPath(com.jniwrapper.Str pszFile,
                    com.jniwrapper.Int cch,
                    Win32FindData pfd,
                    com.jniwrapper.UInt32 fFlags)
             throws com.jniwrapper.win32.com.ComException
Returns the path and file name of a Shell link object.

Parameters:
pszFile - The string that receives the path and file name of the Shell link object.
cch - The maximum number of characters to copy to the string pointed to by the pszFile parameter.
pfd - The address of a Win32FindData class that receives information about the Shell link object. If this parameter is NULL, then no additional information is returned.
fFlags - Flags that specify the type of path information to retrieve.
Throws:
com.jniwrapper.win32.com.ComException

getIDList

public ItemIDList getIDList()
                     throws com.jniwrapper.win32.com.ComException
Returns the list of item identifiers for a Shell link object.

Returns:
The list of item identifiers, represented by ItemIDList class
Throws:
com.jniwrapper.win32.com.ComException

setIDList

public void setIDList(ItemIDList pidl)
               throws com.jniwrapper.win32.com.ComException
Sets the pointer to an item identifier list (PIDL) for a Shell link object

Parameters:
pidl - The list of item identifiers, represented by ItemIDList class
Throws:
com.jniwrapper.win32.com.ComException

getDescription

public com.jniwrapper.Str getDescription(com.jniwrapper.Int cch)
                                  throws com.jniwrapper.win32.com.ComException
Returns the description string for a Shell link object.

Parameters:
cch - The maximum number of characters of string, which is being returned
Returns:
The description string for a Shell link object.
Throws:
com.jniwrapper.win32.com.ComException

setDescription

public void setDescription(com.jniwrapper.Str pszName)
                    throws com.jniwrapper.win32.com.ComException
Sets the description for a Shell link object.

Parameters:
pszName - The description string for a Shell link object.
Throws:
com.jniwrapper.win32.com.ComException

getWorkingDirectory

public com.jniwrapper.Str getWorkingDirectory(com.jniwrapper.Int cch)
                                       throws com.jniwrapper.win32.com.ComException
Returns the name of the working directory for a Shell link object.

Parameters:
cch - The maximum number of characters of string, which is being returned
Returns:
The name of the working directory for a Shell link object.
Throws:
com.jniwrapper.win32.com.ComException

setWorkingDirectory

public void setWorkingDirectory(com.jniwrapper.Str pszDir)
                         throws com.jniwrapper.win32.com.ComException
Sets the name of the working directory for a Shell link object.

Parameters:
pszDir - The name of the working directory for a Shell link object.
Throws:
com.jniwrapper.win32.com.ComException

getArguments

public com.jniwrapper.Str getArguments(com.jniwrapper.Int cch)
                                throws com.jniwrapper.win32.com.ComException
Returns the command-line arguments associated with a Shell link object.

Parameters:
cch - The maximum number of characters of string, which is being returned
Returns:
The command-line arguments string
Throws:
com.jniwrapper.win32.com.ComException

setArguments

public void setArguments(com.jniwrapper.Str pszArgs)
                  throws com.jniwrapper.win32.com.ComException
Sets the command-line arguments for a Shell link object.

Parameters:
pszArgs - The command-line arguments string
Throws:
com.jniwrapper.win32.com.ComException

getHotkey

public com.jniwrapper.UInt16 getHotkey()
                                throws com.jniwrapper.win32.com.ComException
Returns the keyboard shortcut (hot key) for a Shell link object.

Returns:
The virtual key code
Throws:
com.jniwrapper.win32.com.ComException

setHotkey

public void setHotkey(com.jniwrapper.UInt16 wHotkey)
               throws com.jniwrapper.win32.com.ComException
Sets a keyboard shortcut (hot key) for a Shell link object.

Parameters:
wHotkey - The virtual key code
Throws:
com.jniwrapper.win32.com.ComException

getShowCmd

public com.jniwrapper.Int getShowCmd()
                              throws com.jniwrapper.win32.com.ComException
Returns the show command for a Shell link object.

Returns:
Value, which specifies the show command
Throws:
com.jniwrapper.win32.com.ComException

setShowCmd

public void setShowCmd(com.jniwrapper.Int iShowCmd)
                throws com.jniwrapper.win32.com.ComException
Sets the show command for a Shell link object. The show command sets the initial show state of the window.

Parameters:
iShowCmd - Value, which specifies the show command
Throws:
com.jniwrapper.win32.com.ComException

getIconLocation

public void getIconLocation(com.jniwrapper.Str pszIconPath,
                            com.jniwrapper.Int cch,
                            com.jniwrapper.Int piIcon)
                     throws com.jniwrapper.win32.com.ComException
Returns the location (path and index) of the icon for a Shell link object.

Parameters:
pszIconPath - String that receives the path of the file containing the icon.
cch - The maximum number of characters to copy to the string pointed to by the pszIconPath parameter.
piIcon - Value that receives the index of the icon.
Throws:
com.jniwrapper.win32.com.ComException

setIconLocation

public void setIconLocation(com.jniwrapper.Str pszIconPath,
                            com.jniwrapper.Int iIcon)
                     throws com.jniwrapper.win32.com.ComException
Sets the location (path and index) of the icon for a Shell link object.

Parameters:
pszIconPath - The path of the file containing the icon.
iIcon - The index of the icon.
Throws:
com.jniwrapper.win32.com.ComException

setRelativePath

public void setRelativePath(com.jniwrapper.Str pszPathRel,
                            com.jniwrapper.UInt32 dwReserved)
                     throws com.jniwrapper.win32.com.ComException
Sets the relative path to the Shell link object.

Parameters:
pszPathRel - String that contains the new relative path. It should be a file name, not a folder name.
dwReserved - Reserved. Set this parameter to zero.
Throws:
com.jniwrapper.win32.com.ComException

resolve

public void resolve(Wnd hwnd,
                    com.jniwrapper.UInt32 fFlags)
             throws com.jniwrapper.win32.com.ComException
Attempts to find the target of a Shell link, even if it has been moved or renamed.

Parameters:
hwnd - A handle to the window that the Shell will use as the parent for a dialog box. The Shell displays the dialog box if it needs to prompt the user for more information while resolving a Shell link.
fFlags - Action flags.
Throws:
com.jniwrapper.win32.com.ComException

setPath

public void setPath(com.jniwrapper.Str pszFile)
             throws com.jniwrapper.win32.com.ComException
Sets the path and file name of a Shell link object.

Parameters:
pszFile - String that contains the new path.
Throws:
com.jniwrapper.win32.com.ComException