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
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
%
% Arguments.R
%
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\name{Arguments$getFilename}
\alias{Arguments$getFilename}
\alias{getFilename.Arguments}
\alias{Arguments.getFilename}
\alias{getFilename,Arguments-method}
\title{Gets and validates a filename}
\description{
Gets and validates a filename.
}
\usage{
## Static method (use this):
## Arguments$getFilename(filename, nchar=c(1, 128), class=c("safe"), .name=NULL,
## .type="filename", ...)
## Don't use the below:
\method{getFilename}{Arguments}(static, filename, nchar=c(1, 128), class=c("safe"), .name=NULL,
.type="filename", ...)
}
\arguments{
\item{filename}{A \code{\link[base]{character}} string.}
\item{nchar}{An \code{\link[base]{integer}} \code{\link[base]{vector}} of length two specifying the range
of valid filename lengths.}
\item{class}{A \code{\link[base]{character}} string specifying the class of valid
filenames.}
\item{.name}{The name of the argument validated.}
\item{.type}{Not used.}
\item{...}{Not used.}
}
\value{
Returns a \code{\link[base]{character}} string if filename is valid,
otherwise an exception is thrown.
}
\section{Missing values}{
If \code{filename} is a missing value, then an exception is thrown.
}
\details{
When argument \code{class="safe"}, the following 86 ASCII characters
are allowed in filenames:
\preformatted{
#$%&'()+,-.0123456789;= (24 including initial space)
@ABCDEFGHIJKLMNOPQRSTUVWXYZ[]^_ (31)
`abcdefghijklmnopqrstuvwxyz{|}~ (31)
}
This class of filenames has been extensively tested on for
cross-platform support on Microsoft Windows, macOS, and various
Unix flavors.
}
\references{
[1] Microsoft, \emph{Naming Files, Paths, and Namespaces}, 2018.
\url{https://learn.microsoft.com/en-us/windows/win32/fileio/naming-a-file}.
}
\author{Henrik Bengtsson}
\seealso{
For more information see \code{\link{Arguments}}.
}
\keyword{internal}
\keyword{methods}
|
