本日はC#の小ネタ枠です。
ファイルまたはフォルダ作成時にWindowsで利用不可なファイル名かチェックする方法です。
Windowsのファイル名には利用不可能な予約文字や予約名が存在します。
これらを含むファイル名は通常利用できず、何らかの要因で誤って利用した場合問題が発生することがあります。
learn.microsoft.com
例えばWindowsで利用不可な予約文字は以下の通りです。
< (より小さい)
> (より大きい)
: (コロン)
" (二重引用符)
/ (スラッシュ)
\ (円記号)
| (縦棒またはパイプ)
? (疑問符)
* (アスタリスク)
利用不可な予約名は以下の通りです。
CON、PRN、AUX、NUL、
COM0、COM1、COM2、COM3、COM4、COM5、COM6、COM7、COM8、COM9、COM¹、COM²、COM³、
LPT0、LPT1、LPT2、LPT3、LPT4、LPT5、LPT6、LPT7、LPT8、LPT9、LPT¹、LPT²、LPT³
これらの利用不可なファイル名かチェックを行う以下のサンプルスクリプトを作成しました。
・FileNameCheckTest2.cs
using System;
using System.IO;
using UnityEngine;
public class FileNameCheckTest2 : MonoBehaviour
{
<summary>
</summary>
[SerializeField]
private string fileName = default;
private string DocumentFolderPath => System.Environment.GetFolderPath(System.Environment.SpecialFolder.MyDocuments);
<summary>
</summary>
private static readonly char[] InvalidFileNameCharsWindows = new Char[]
{
'<', '>', ':', '"', '/', '\\', '|', '?', '*'
};
<summary>
</summary>
private static readonly string[] InvalidFileNameWindows = new string[]
{
"CON", "PRN", "AUX", "NUL",
"COM0", "COM1", "COM2", "COM3", "COM4", "COM5", "COM6", "COM7", "COM8", "COM9", "COM¹", "COM²", "COM³",
"LPT0", "LPT1", "LPT2", "LPT3", "LPT4", "LPT5", "LPT6", "LPT7", "LPT8", "LPT9", "LPT¹", "LPT²", "LPT³"
};
[ContextMenu("CreateFile")]
public void CreateFile()
{
if (fileName.IndexOfAny(InvalidFileNameCharsWindows) >= 0)
{
Debug.LogError($"Invalid FileName: {fileName}");
return;
}
var fileNameWithoutExtension = Path.GetFileNameWithoutExtension(fileName).ToUpper();
if (Array.Exists(InvalidFileNameWindows, x => x == fileNameWithoutExtension))
{
Debug.LogError($"Invalid FileName: {fileName}");
return;
}
var fileFolderPath = Path.Combine(DocumentFolderPath, "ScriptTest");
var newFilePath = Path.Combine(fileFolderPath, "newFile.txt");
if (!File.Exists(newFilePath)) File.Create(newFilePath).Close();
Debug.Log($"Create File: {newFilePath}");
}
}
利用不可なファイル名を指定した場合、エラーメッセージを返してファイルを作成しません。
