djkato/luadocs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
luadocs/content/lua.scripts.api.manual/dtutils.file/sanitize_filename.md
Bill Ferguson b69d752221 [lua scripts] created manual from script comments 
[lua scripts api] created manual from embedded library documentation

[lua api] created stub to contain lua api manual
2020-12-12 15:14:19 -05:00

599 B
Raw Blame History

title id weight draft author
sanitize_filename sanitize_filename 170 false people

NAME

sanitize_filename

SYNOPSIS

make a filename safe to pass as an argument

USAGE

local df = require "lib/dtutils.file"
local sanitized_filename = df.sanitize_filename(filename)

filename - string - a filepath and filename

DESCRIPTION

sanitize_filename places quotes around the filename in an operating system specific manner. The result is safe to pass as an argument to the operating system.

RETURN VALUE

sanitized_filename - string - quoted filename