Gemstone Common Library
File
Gets a valid file name by replacing invalid file name characters with replaceWithCharacter.
Definition
Namespace: Gemstone.IO
Assembly: Gemstone.Common (in Gemstone.Common.dll) Version: 1.0.150 -- Release Build+64e3b411e1abfbd2d4d8a81e850c3909a0ce8731
A valid file name with no invalid file name characters.
Assembly: Gemstone.Common (in Gemstone.Common.dll) Version: 1.0.150 -- Release Build+64e3b411e1abfbd2d4d8a81e850c3909a0ce8731
C#
public static string GetValidFileName(
string fileName,
char replaceWithCharacter = '_'
)VB
Public Shared Function GetValidFileName (
fileName As String,
Optional replaceWithCharacter As Char = "_"C
) As StringC++
public:
static String^ GetValidFileName(
String^ fileName,
wchar_t replaceWithCharacter = L'_'
)JavaScript
Gemstone.IO.FilePath.GetValidFileName = function(fileName, replaceWithCharacter);Parameters
- 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.