FilePathGetValidFileName Method

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.175 -- Release Build+70cfebd19f80455d07e1cf93607e59f6af0e38f4

C#View Source Request Example

public static string GetValidFileName(
	string fileName,
	char replaceWithCharacter = '_'
)

VBView Source Request Example

Public Shared Function GetValidFileName ( 
	fileName As String,
	Optional replaceWithCharacter As Char = "_"C
) As String

C++View Source Request Example

public:
static String^ GetValidFileName(
	String^ fileName, 
	wchar_t replaceWithCharacter = L'_'
)

JavaScriptView Source Request Example

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

String
A 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.

FilePathGetValidFileName Method

Definition

Parameters

Return Value

Remarks

See Also

Reference