Shell

Shell automation module.

Summary

Shell	Shell automation module.
Restart	Restarts shell.
SMShow	Show start menu on particular location.
SMAdd	Add shortcuts to start menu programs group.
GetCommonPath	Return location of standard system folders.
GetQuickLaunch	Returns files from the quick launch location.
SetHook
EGetCount	Get the number of items in the view.
EGetIEObject	Get IWebBrowser2 interface pointer from open explorer windows.
GetPath	Returns the currently open file system path in the given explorer window.
GetSelection	Get selected item(s)
GetView	Gets the current view of desired Explorer window.
ESelectItem	Select item by index.
SetPath	Open the folder in given explorer window
SetView	Sets the view in desired Explorer window
Examples	Display info about active Explorer window
About

Restart

Shell_Restart()

Restarts shell.

Remarks

The effect is the same as killing the explorer.exe using task manager and starting it again. Function will try to prevent execution of start-up group when explorer is started again.

Returns

Pid of the new shell instance.

SMShow

Shell_SMShow( X = "",
Y = "",
Transparency = "",
bHideShadow = 1 )

Show start menu on particular location.

Parameters

X, Y	Coordinate on which to show Start Menu. Omit both parameters to show the Start Menu on its original location.
Transparency	Window transparency, by default 255.
bHideShadow	Hide Start Menu Shadow. On some systems showing the menu on non-default position will bug up shadow. Enabled by default.

Remarks

ESC key will not close the window if you used X and Y parameters. To close the window you can use the following code:

ESC:: WinHide, ahk_class DV2ControlHost

SMAdd

Shell_SMAdd( Parent,
FileName = "",
o1 = "",
o2 = "",
o3 = "",
o4 = "",
o5 = "",
o6 = "",
o7 = "" )

Add shortcuts to start menu programs group.

Parameters

Parent	Name of the parent folder, relative to the Programs folder. Specify “!” to add file to the StartUp group.
FileName	Name of the file. If omited, only Parent will be created. If starts with the “!”, file will be added to the Start Menu for all users. FileName doesn’t have to exist.
o1..o7	Named parameters: Name, WDir, Args, Desc, Icon, Shortcut, IconNumber, RunState. Those parameters will be passed to FileCrateShortuct. If Name is not present function will use name of the input file.

GetCommonPath

Shell_GetCommonPath( Name )

Return location of standard system folders.

Parameters

Name	Name of the sysetem folder.

Folders

Bellow is the list of available folders and their typical locations :

APPDATA	C:\Documents and Settings\username\Application Data.
COOKIES	C:\Documents and Settings\username\Cookies.
COMMON_APPDATA	C:\Documents and Settings\All Users\Application Data.
COMMON_DOCUMENTS	C:\Documents and Settings\All Users\Documents.
COMMON_PROGRAMS	C:\Documents and Settings\All Users\Start Menu\Programs.
COMMON_STARTMENU	C:\Documents and Settings\All Users\Start Menu.
COMMON_STARTUP	C:\Documents and Settings\All Users\Start Menu\Programs\Startup.
DESKTOP	C:\Documents and Settings\username\Desktop.
FONTS	C:\Windows\Fonts.
FAVORITES	C:\Documents and Settings\username\Favorites.
LOCAL_APPDATA	C:\Documents and Settings\username\Local Settings\Application Data.
MYMUSIC	C:\Documents and Settings\User\My Documents\My Music.
MYPICTURES	C:\Documents and Settings\username\My Documents\My Pictures.
MYVIDEO	C:\Documents and Settings\username\My Documents\My Videos.
PERSONAL	C:\Documents and Settings\username\My Documents.
PROGRAM_FILES_COMMON	C:\Program Files\Common.
PROGRAM_FILES	C:\Program Files.
PROGRAMS	C:\Documents and Settings\username\Start Menu\Programs.
PROFILE	C:\Documents and Settings\username.
PROFILES	C:\Documents and Settings.
RESOURCES	C:\WINDOWS\Resources\ (For theme and other windows resources).
SENDTO	C:\Documents and Settings\username\SendTo.
STARTMENU	C:\Documents and Settings\username\Start Menu.
STARTUP	C:\Documents and Settings\username\Start Menu\Programs\Startup.
SYSTEM	C:\Windows\System32.
WINDOWS	C:\Windows.

Returns

Full path

Reference

http://msdn.microsoft.com/en-us/library/bb762494(VS.85).aspx

GetQuickLaunch

Shell_GetQuickLaunch()

Returns files from the quick launch location.

SetHook

Shell_SetHook( Handler = "" )

Parameter

Handler

Name of the function to call on shell events. Omit to disable the active hook.

Handler

Event	Event for which handler is called.
Param	Parameter of the handler. Parameters are given bellow for each reason.

OnShell(Reason, Param) {
    static WINDOWCREATED=1, WINDOWDESTROYED=2, WINDOWACTIVATED=4, GETMINRECT=5, REDRAW=6, TASKMAN=7, APPCOMMAND=12
}

Param

WINDOWACTIVATED	The HWND handle of the activated window.
WINDOWREPLACING	The HWND handle of the window replacing the top-level window.
WINDOWCREATED	The HWND handle of the window being created.
WINDOWDESTROYED	The HWND handle of the top-level window being destroyed.
GETMINRECT	A pointer to a RECT structure.
TASKMAN	Can be ignored.
REDRAW	The HWND handle of the window that needs to be redrawn.

Remarks

Requires explorer to be set as a shell in order to work.

Returns

0 on failure, name of the previous hook procedure on success.

Reference

http://msdn.microsoft.com/en-us/library/ms644989(VS.85).aspx

EGetCount

Shell_EGetCount( pHwnd,
flag = "" )

Get the number of items in the view.

Parameters

pHwnd	Handle to windows explorer instance.
flag	set “sel” to get number of selected items.

Returns

Number of items, or -1 on failure.

EGetIEObject

Shell_EGetIEObject( hwndFind = "" )

Get IWebBrowser2 interface pointer from open explorer windows.

Parameters

hwndFind

Return interface pointer for instance with given hwnd.

Returns

IWebBrowser2 interface pointer.

GetPath

Shell_EGetPath( pHwnd )

Returns the currently open file system path in the given explorer window.

Parameters

pHwnd

Handle to windows explorer instance.

Returns

Path of currently open folder.

GetSelection

Shell_EGetSelection( pHwnd )

Get selected item(s)

Parameters

hwnd	Handle of Explorer window.

Returns

Path of each selected item.

GetView

Shell_EGetView( pHwnd )

Gets the current view of desired Explorer window.

Parameters

pHwnd

Handle to windows explorer instance.

Returns: View mode type, see SetView

ESelectItem

Shell_ESelectItem( hwnd,
idx1,
idx2 = "" )

Select item by index.

Parameters

hwnd	Handle of Explorer window.
idx1	0 based index of item to select.
idx2	All items up to the idx2 will be selected. Keep in mind that this method selects items 1 by 1 thus selecting large amount of items isn’t efficient.

SetPath

Shell_ESetPath( pHwnd,
pPath )

Open the folder in given explorer window

Parameters

pHwnd	Handle to windows explorer instance
pPath	path to be set or one of the tree symbols: > (go forward), < (go back), \| (go up) Returns: True on success

SetView

Shell_ESetView( pHwnd,
pView )

Sets the view in desired Explorer window

Parameters

pHwnd	Handle to windows explorer instance.
pView	Number, view mode type. ICON (1), SMALLICON (2), LIST (3), DETAILS (4), THUMBNAIL (5), TILE (6), THUMBSTRIP (7)

Examples

Display info about active Explorer window

       h := WinExist("ahk_class ExploreWClass")

       p := "Path: " Shell_GetPath( h )
       s := "Sel:`n" Shell_GetSelection( hwnd)

       msgbox %p%`n%s%

About

Ver 2.0 by majkinetor. See http://www.autohotkey.com/forum/topic19400.html
Licenced under GNU GPL http://creativecommons.org/licenses/GPL/2.0/