1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
%
% createWindowsShortcut.R
%
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\name{createWindowsShortcut}
\alias{createWindowsShortcut.default}
\alias{createWindowsShortcut}
\title{Creates a Microsoft Windows Shortcut (.lnk file)}
\usage{
\method{createWindowsShortcut}{default}(pathname, target, overwrite=FALSE, mustWork=FALSE, ...)
}
\description{
Creates a Microsoft Windows Shortcut (.lnk file).
}
\arguments{
\item{pathname}{The pathname (with file extension *.lnk) of the link
file to be created.}
\item{target}{The target file or directory to which the shortcut should
point to.}
\item{overwrite}{If \code{\link[base:logical]{TRUE}}, an existing link file is overwritten,
otherwise not.}
\item{mustWork}{If \code{\link[base:logical]{TRUE}}, an error is produced if the Windows Shortcut
link is not created, otherwise not.}
\item{...}{Not used.}
}
\value{
Returns (invisibly) the pathname.
}
\section{Required privileges on Windows}{
In order for this method, which utilizes Windows Script Host a VBScript,
to succeed on Windows, the client/R session must run with sufficient
privileges (it has been reported that Administrative rights are necessary).
}
\examples{
# Create Windows Shortcut links to a directory and a file
targets <- list(
system.file(package="R.utils"),
system.file("DESCRIPTION", package="R.utils")
)
for (kk in seq_along(targets)) {
cat("Link #", kk, "\n", sep="")
target <- targets[[kk]]
cat("Target: ", target, "\n", sep="")
# Name of *.lnk file
pathname <- sprintf("\%s.LNK", tempfile())
tryCatch({
# Will only work on Windows systems with support for VB scripting
createWindowsShortcut(pathname, target=target)
}, error = function(ex) {
print(ex)
})
# Was it created?
if (isFile(pathname)) {
cat("Created link file: ", pathname, "\n", sep="")
# Validate that it points to the correct target
dest <- filePath(pathname, expandLinks="any")
cat("Available target: ", dest, "\n", sep="")
res <- all.equal(tolower(dest), tolower(target))
if (!isTRUE(res)) {
msg <- sprintf("Link target does not match expected target: \%s != \%s", dest, target)
cat(msg, "\n")
warning(msg)
}
# Cleanup
file.remove(pathname)
}
}
}
\author{Henrik Bengtsson}
\seealso{
\code{\link{readWindowsShortcut}}()
}
\references{
[1] Create a windows shortcut (.LNK file), SS64.com,
\url{https://ss64.com/nt/shortcut.html} \cr
}
\keyword{file}
\keyword{IO}
|
