|
FilePathGetValidFileName Method
|
Gets a valid file name by replacing invalid file name characters with replaceWithCharacter.
Namespace: GSF.IOAssembly: GSF.Core (in GSF.Core.dll) Version: 2.4.207-beta+1781b796b2aa7a54013a031eb432fe4ccee31867
Syntax public static string GetValidFileName(
string fileName,
char replaceWithCharacter = '_'
)
Public Shared Function GetValidFileName (
fileName As String,
Optional replaceWithCharacter As Char = "_"C
) As String
public:
static String^ GetValidFileName(
String^ fileName,
wchar_t replaceWithCharacter = L'_'
)
static member GetValidFileName :
fileName : string *
?replaceWithCharacter : char
(* Defaults:
let _replaceWithCharacter = defaultArg replaceWithCharacter '_'
*)
-> string
GSF.IO.FilePath.GetValidFileName = function(fileName, replaceWithCharacter);
View SourceParameters
- fileName String
- File name to validate.
- replaceWithCharacter Char (Optional)
- Character to replace invalid file name characters with. Set to '\0' to remove invalid file name characters.
Return Value
StringA valid file name with no invalid file name characters.
Remarks
This function expects a file name, not a file name with a path. To properly get a valid file path, where all directory
names and the file name are validated, use the
GetValidFilePath(String, Char). Calling the
GetValidFileName(String, Char)
function will a full path will yield all directory separators replaced with the
replaceWithCharacter.
See Also