Shortcut Classes

Members (15)

Documentation

Shortcut Classes

CShortcut allows to create a shortcut programmatically.

CURLShortcut allows to create a URL shortcut programmatically.

Include file: AfxNova/CShortcut.inc

---

Constructors

CONSTRUCTOR CShortcut (BYREF wszPathName AS WSTRING)

Example

' Creates a shortcut programatically (if it already exists, opens it)
DIM pShortcut AS CShortcut = ExePath & "\Test.lnk"   ' --> change me
' Sets various properties and saves them to disk
pShortcut.Description = "Hello world"   ' --> change me
pShortcut.WorkingDirectory = ExePath & "\"   ' --> change me
pShortcut.Arguments = "/c"   ' --> change me
pShortcut.HotKey = "Ctrl+Alt+e"   ' --> change me
pShortcut.IconLocation = ExePath & "\Program.ico,0"   ' --> change me
pShortcut.RelativePath = ExePath & "\"   ' --> change me
pShortcut.TargetPath = ExePath & $"\HelloWord.exe"   ' --> change me
pShortcut.WindowStyle = WshNormalFocus
pShortcut.Save

CONSTRUCTOR CURLShortcut (BYREF wszPathName AS WSTRING)

' Creates a shortcut programatically (if it already exists, opens it)
DIM pURLShortcut AS CURLShortcut = ExePath & "\Microsoft Web Site.url"   ' --> change me
pURLShortcut.TargetPath = "http://www.microsoft.com"   ' --> change me
pURLShortcut.Save

---

CShortcut Methods

---

CShortcut Properties

---

CURLShortcut Methods

---

CShortcut Properties

---

Save (CShortcut)

Saves a shortcut object to disk.

FUNCTION Save () AS HRESULT

Remarks

After creating an instance of the CShortcut* class to create to create a shortcut object and set the shortcut object's properties, the Save method must be used to save the shortcut object to disk. The **Save method uses the information in the shortcut object's FullName property to determine where to save the shortcut object on a disk. You can only create shortcuts to system objects. This includes files, directories, and drives (but does not include printer links or scheduled tasks).

Return value

HRESULT. S_OK (0) on success, or an error code on failure.

---

Save (CURLShortcut)

Saves a URL shortcut object to disk.

FUNCTION Save () AS HRESULT

Remarks

After creating an instance of the CURLShortcut class to create to create a shortcut object and set the shortcut object's properties, the Save method must be used to save the shortcut object to disk. The Save method uses the information in the shortcut object's FullName property to determine where to save the shortcut object on a disk. You can only create shortcuts to system objects. This includes files, directories, and drives (but does not include printer links or scheduled tasks).

Return value

HRESULT. S_OK (0) on success, or an error code on failure.

---

GetLastResult

Returns the last result code.

FUNCTION GetLastResult () AS HRESULT

Return value

HRESULT. S_OK (0) on success, or an error code on failure.

---

GetErrorInfo

Returns a localized description of the specified error code. If the error is omited, it will return the value returned by GetLastResult.

FUNCTION GetErrorInfo (BYVAL nError AS LONG = -1) AS DWSTRING

---

Arguments

Gets/sets the arguments for a shortcut, or identifies a shortcut's arguments.

PROPERTY Arguments () AS DWSTRING
PROPERTY Arguments (BYREF wszArguments AS WSTRING)

Return value

The arguments of the shortcut.

---

Description

Returns or sets a shortcut's description.

PROPERTY Description () AS DWSTRING
PROPERTY Description (BYREF wszDescription AS WSTRING)

Return value

The description of the shortcut.

---

FullName (CShortcut)

Returns the fully qualified path of the shortcut object's target.

PROPERTY FullName () AS DWSTRING

Remarks

The FullName property contains a read-only string value indicating the fully qualified path to the shortcut's target.

---

FullName (CURLShortcut)

Returns the fully qualified path of the shortcut object's target.

PROPERTY FullName () AS DWSTRING

Remarks

The FullName property contains a read-only string value indicating the fully qualified path to the shortcut's target.

---

Hotkey

Assigns a key-combination to a shortcut, or identifies the key-combination assigned to a shortcut.

PROPERTY Hotkey () AS DWSTRING
PROPERTY Hotkey (BYREF wszHotkey AS WSTRING)

Return value

The hotkey of the shortcut.

---

IconLocation

Assigns a an icon to a shortcut, or identifies the icon assigned to a shortcut.

PROPERTY IconLocation () AS DWSTRING
PROPERTY IconLocation (BYREF wszIconLocation AS WSTRING)

Return value

The location of the icon.

---

RelativePath

Assigns a relative path to a shortcut.

PROPERTY RelativePath (BYREF wszRelativePath AS WSTRING)

---

TargetPath (CShortcut)

Gets/sets the path of the shortcut's executable.

PROPERTY TargetPath () AS DWSTRING
PROPERTY TargetPath (BYREF wszTargetPath AS WSTRING)

Return value

The path of the shortcut's executable.

---

TargetPath (CURLShortcut)

Gets/sets the path of the shortcut's executable.

PROPERTY TargetPath () AS DWSTRING
PROPERTY TargetPath (BYREF wszTargetPath AS WSTRING)

Return value

The path of the shortcut's executable.

---

WindowStyle

Assigns a window style to a shortcut, or identifies the type of window style used by a shortcut.

PROPERTY WindowStyle () AS LONG
PROPERTY WindowStyle (BYVAL nWindowStyle AS LONG)

The following table lists the available settings for nWindowStyle.

Return value

LONG. The window style.

---

WorkingDirectory

Assigns a working directory to a shortcut, or identifies the working directory used by a shortcut.

PROPERTY WorkingDirectory () AS DWSTRING
PROPERTY WorkingDirectory (BYREF wszWorkingDirectory AS WSTRING)

Return value

The working directory of the shortcut.

---