CPathT クラス

[アーティクル]
04/03/2023

このクラスは、パスを表します。

重要

このクラスとそのメンバーは、Windows ランタイムで実行するアプリケーションで使用することはできません。

構文

template <typename StringType>
class CPathT

パラメーター

StringType
パスに使用する ATL/MFC 文字列クラス (CStringT に関するページを参照)。

メンバー

パブリック typedef

名前	説明
CPathT::PCXSTR	定数文字列型。
CPathT::PXSTR	文字列型。
CPathT::XCHAR	文字型。

パブリックコンストラクター

名前	説明
CPathT::CPathT	パスのコンストラクター。

パブリックメソッド

名前	説明
CPathT::AddBackslash	パスの正しい構文を作成するために、文字列の末尾に円記号を追加するには、このメソッドを呼び出します。
CPathT::AddExtension	ファイル拡張子をパスに追加するには、このメソッドを呼び出します。
CPathT::Append	文字列を現在のパスに追加するには、このメソッドを呼び出します。
CPathT::BuildRoot	特定のドライブ番号からルートパスを作成するには、このメソッドを呼び出します。
CPathT::Canonicalize	パスを正規形式に変換するには、このメソッドを呼び出します。
CPathT::Combine	ディレクトリ名を表す文字列と、ファイルパス名を表す文字列を 1 つのパスに連結するには、このメソッドを呼び出します。
CPathT::CommonPrefix	指定したパスと現在のパスとで共通のプレフィックスが共有されるかどうかを判断するには、このメソッドを呼び出します。
CPathT::CompactPath	パスコンポーネントを省略記号に置き換えることで、特定のピクセル幅に収まるようにファイルパスを切り詰めるには、このメソッドを呼び出します。
CPathT::CompactPathEx	パスコンポーネントを省略記号に置き換えることで、特定の文字数に収まるようにファイルパスを切り詰めるには、このメソッドを呼び出します。
CPathT::FileExists	このパス名のファイルが存在するかどうかを確認するには、このメソッドを呼び出します。
CPathT::FindExtension	パス内のファイル拡張子の位置を検索するには、このメソッドを呼び出します。
CPathT::FindFileName	パス内のファイル名の位置を検索するには、このメソッドを呼び出します。
CPathT::GetDriveNumber	'A' から 'Z' の範囲内のドライブ文字のパスを検索し、対応するドライブ番号を返すには、このメソッドを呼び出します。
CPathT::GetExtension	パスからファイル拡張子を取得するには、このメソッドを呼び出します。
CPathT::IsDirectory	パスが有効なディレクトリであるかどうかを確認するには、このメソッドを呼び出します。
CPathT::IsFileSpec	パス区切り文字 (`:` や `\` など) を検索するには、このメソッドを呼び出します。パス区切り文字が存在しない場合、パスはファイル仕様パスと見なされます。
CPathT::IsPrefix	pszPrefix によって渡された型の有効なプレフィックスがパスに含まれているかどうかを判断するには、このメソッドを呼び出します。
CPathT::IsRelative	パスが相対パスであるかどうかを判断するには、このメソッドを呼び出します。
CPathT::IsRoot	パスがディレクトリルートであるかどうかを判断するには、このメソッドを呼び出します。
CPathT::IsSameRoot	現在のパスと共通のルートコンポーネントが別のパスに含まれるかどうかを判断するには、このメソッドを呼び出します。
CPathT::IsUNC	パスがサーバーおよび共有の有効な UNC (汎用名前付け規則) パスであるかどうかを判断するには、このメソッドを呼び出します。
CPathT::IsUNCServer	パスがサーバーのみの有効な UNC (汎用名前付け規則) パスであるかどうかを判断するには、このメソッドを呼び出します。
CPathT::IsUNCServerShare	パスが有効な UNC (汎用名前付け規則) 共有パス (`\\server\share`) であるかどうかを判断するには、このメソッドを呼び出します。
CPathT::MakePretty	パスをすべて小文字に変換して、パスを一貫した外観にするには、このメソッドを呼び出します。
CPathT::MatchSpec	ワイルドカードの一致の種類を含む文字列のパスを検索するには、このメソッドを呼び出します。
CPathT::QuoteSpaces	スペースが含まれている場合にパスを引用符で囲むには、このメソッドを呼び出します。
CPathT::RelativePathTo	ファイル間またはフォルダー間で相対パスを作成するには、このメソッドを呼び出します。
CPathT::RemoveArgs	パスからコマンドライン引数を削除するには、このメソッドを呼び出します。
CPathT::RemoveBackslash	パスから末尾の円記号を削除するには、このメソッドを呼び出します。
CPathT::RemoveBlanks	パスから先頭と末尾のスペースをすべて削除するには、このメソッドを呼び出します。
CPathT::RemoveExtension	パスからファイル拡張子 (存在する場合) を削除するには、このメソッドを呼び出します。
CPathT::RemoveFileSpec	パスの末尾にあるファイル名と円記号を削除するには、このメソッドを呼び出します。
CPathT::RenameExtension	パスのファイル名拡張子を新しい拡張子に置き換えるには、このメソッドを呼び出します。ファイル名に拡張子が含まれていない場合は、文字列の末尾にこの拡張子が付けられます。
CPathT::SkipRoot	ドライブ文字、または UNC サーバーか共有パスの部分を無視してパスを解析するには、このメソッドを呼び出します。
CPathT::StripPath	完全修飾パスとファイル名のパスの部分を削除するには、このメソッドを呼び出します。
CPathT::StripToRoot	ルート情報を除くパスのすべての部分を削除するには、このメソッドを呼び出します。
CPathT::UnquoteSpaces	パスの先頭と末尾から引用符を削除するには、このメソッドを呼び出します。

パブリック演算子

名前	説明
CPathT::operator const StringType >	この演算子を使用すると、オブジェクトを文字列のように処理できます。
CPathT::operator CPathT::PCXSTR	この演算子を使用すると、オブジェクトを文字列のように処理できます。
CPathT::operator StringType &	この演算子を使用すると、オブジェクトを文字列のように処理できます。
CPathT::operator +=	この演算子では、文字列をパスに追加します。

パブリックデータメンバー

名前	説明
CPathT::m_strPath	パス。

解説

CPath、CPathA、および CPathW は、次のように定義された CPathT のインスタンス化です。

typedef CPathT< CString > CPath;

typedef CPathT< CStringA > CPathA;

typedef CPathT< CStringW > CPathW;

要件

ヘッダー: atlpath.h

CPathT::AddBackslash

パスの正しい構文を作成するために、文字列の末尾に円記号を追加するには、このメソッドを呼び出します。パスに末尾の円記号が既に含まれる場合、円記号は追加されません。

void AddBackslash();

解説

詳細については、PathAddBackSlash に関するページを参照してください。

CPathT::AddExtension

ファイル拡張子をパスに追加するには、このメソッドを呼び出します。

BOOL AddExtension(PCXSTR pszExtension);

パラメーター

pszExtension
追加するファイル拡張子。

戻り値

成功した場合は TRUE を返し、失敗した場合は FALSE を返します。

解説

詳細については、PathAddExtension に関するページを参照してください。

CPathT::Append

文字列を現在のパスに追加するには、このメソッドを呼び出します。

BOOL Append(PCXSTR pszMore);

パラメーター

pszMore
追加する文字列。

戻り値

成功した場合は TRUE を返し、失敗した場合は FALSE を返します。

解説

詳細については、PathAppend に関するページを参照してください。

CPathT::BuildRoot

特定のドライブ番号からルートパスを作成するには、このメソッドを呼び出します。

void BuildRoot(int iDrive);

パラメーター

iDrive
ドライブ番号 (0 は A:、1 は B: など)。

解説

詳細については、PathBuildRoot に関するページを参照してください。

CPathT::Canonicalize

パスを正規形式に変換するには、このメソッドを呼び出します。

void Canonicalize();

解説

詳細については、PathCanonicalize に関するページを参照してください。

CPathT::Combine

ディレクトリ名を表す文字列と、ファイルパス名を表す文字列を 1 つのパスに連結するには、このメソッドを呼び出します。

void Combine(PCXSTR pszDir, PCXSTR  pszFile);

パラメーター

pszDir
ディレクトリのパスです。

pszFile
ファイルパス。

解説

詳細については、PathCombine に関するページを参照してください。

CPathT::CommonPrefix

指定したパスと現在のパスとで共通のプレフィックスが共有されるかどうかを判断するには、このメソッドを呼び出します。

CPathT<StringType> CommonPrefix(PCXSTR pszOther);

パラメーター

pszOther
現在のパスと比較するパス。

戻り値

共通プレフィックスを返します。

解説

プレフィックスは、"C:\\"、"."、".."、"..\\" の種類のうちいずれかです。詳細については、PathCommonPrefix に関するページを参照してください。

CPathT::CompactPath

パスコンポーネントを省略記号に置き換えることで、特定のピクセル幅に収まるようにファイルパスを切り詰めるには、このメソッドを呼び出します。

BOOL CompactPath(HDC hDC, UINT nWidth);

パラメーター

hDC
フォントメトリックに使用されるデバイスコンテキスト。

nWidth
文字列が強制的に収まるように調整される幅 (ピクセル単位)。

戻り値

成功した場合は TRUE を返し、失敗した場合は FALSE を返します。

解説

詳細については、PathCompactPath に関するページを参照してください。

CPathT::CompactPathEx

パスコンポーネントを省略記号に置き換えることで、特定の文字数に収まるようにファイルパスを切り詰めるには、このメソッドを呼び出します。

BOOL CompactPathEx(UINT nMaxChars, DWORD dwFlags = 0);

パラメーター

nMaxChars
新しい文字列に含まれる最大文字数 (終端の NULL 文字を含む)。

dwFlags
予約済み。

戻り値

成功した場合は TRUE を返し、失敗した場合は FALSE を返します。

解説

詳細については、PathCompactPathEx に関するページを参照してください。

CPathT::CPathT

コンストラクター。

CPathT(PCXSTR pszPath);
CPathT(const CPathT<StringType>& path);
CPathT() throw();

パラメーター

pszPath
パス文字列へのポインター。

path
パス文字列。

CPathT::FileExists

このパス名のファイルが存在するかどうかを確認するには、このメソッドを呼び出します。

BOOL FileExists() const;

戻り値

ファイルが存在する場合は TRUE、それ以外の場合は FALSE を返します。

解説

詳細については、PathFileExists に関するページを参照してください。

CPathT::FindExtension

パス内のファイル拡張子の位置を検索するには、このメソッドを呼び出します。

int FindExtension() const;

戻り値

拡張子の前の "." の位置を返します。拡張子が見つからない場合は、-1 を返します。

解説

詳細については、PathFindExtension に関するページを参照してください。

CPathT::FindFileName

パス内のファイル名の位置を検索するには、このメソッドを呼び出します。

int FindFileName() const;

戻り値

ファイル名の位置を返します。ファイル名が見つからない場合は、-1 を返します。

解説

詳細については、PathFindFileName に関するページを参照してください。

CPathT::GetDriveNumber

'A' から 'Z' の範囲内のドライブ文字のパスを検索し、対応するドライブ番号を返すには、このメソッドを呼び出します。

int GetDriveNumber() const;

戻り値

パスにドライブ文字がある場合は、ドライブ番号を 0 から 25 の整数 ('A' から 'Z' に対応する) として返します。それ以外の場合は -1 を返します。

解説

詳細については、PathGetDriveNumber に関するページを参照してください。

CPathT::GetExtension

パスからファイル拡張子を取得するには、このメソッドを呼び出します。

StringType GetExtension() const;

戻り値

ファイルの拡張子を返します。

CPathT::IsDirectory

パスが有効なディレクトリであるかどうかを確認するには、このメソッドを呼び出します。

BOOL IsDirectory() const;

戻り値

パスがディレクトリである場合は 0 以外の値 (16)、それ以外の場合は FALSE を返します。

解説

詳細については、PathIsDirectory に関するページを参照してください。

CPathT::IsFileSpec

パス区切り文字 (: や \ など) を検索するには、このメソッドを呼び出します。パス区切り文字が存在しない場合、パスはファイル仕様パスと見なされます。

BOOL IsFileSpec() const;

戻り値

パス内にパス区切り文字がない場合は、TRUE を返します。パス区切り文字がある場合は、FALSE を返します。

解説

詳細については、PathIsFileSpec に関するページを参照してください。

CPathT::IsPrefix

pszPrefix によって渡された型の有効なプレフィックスがパスに含まれているかどうかを判断するには、このメソッドを呼び出します。

BOOL IsPrefix(PCXSTR pszPrefix) const;

パラメーター

pszPrefix
検索対象のプレフィックス。プレフィックスは、"C:\\"、"."、".."、"..\\" の種類のうちいずれかです。

戻り値

パスにプレフィックスが含まれている場合は TRUE、それ以外の場合は FALSE を返します。

解説

詳細については、PathIsPrefix に関するページを参照してください。

CPathT::IsRelative

パスが相対パスであるかどうかを判断するには、このメソッドを呼び出します。

BOOL IsRelative() const;

戻り値

相対パスの場合は TRUE、絶対パスの場合は FALSE を返します。

解説

詳細については、PathIsRelative に関するページを参照してください。

CPathT::IsRoot

パスがディレクトリルートであるかどうかを判断するには、このメソッドを呼び出します。

BOOL IsRoot() const;

戻り値

パスがルートである場合は TRUE、それ以外の場合は FALSE を返します。

解説

詳細については、PathIsRoot に関するページを参照してください。

CPathT::IsSameRoot

現在のパスと共通のルートコンポーネントが別のパスに含まれるかどうかを判断するには、このメソッドを呼び出します。

BOOL IsSameRoot(PCXSTR pszOther) const;

パラメーター

pszOther
もう 1 つのパス。

戻り値

両方の文字列が同じルートコンポーネントを持つ場合は TRUE、それ以外の場合は FALSE を返します。

解説

詳細については、PathIsSameRoot に関するページを参照してください。

CPathT::IsUNC

パスがサーバーおよび共有の有効な UNC (汎用名前付け規則) パスであるかどうかを判断するには、このメソッドを呼び出します。

BOOL IsUNC() const;

戻り値

パスが有効な UNC パスである場合は TRUE、それ以外の場合は FALSE を返します。

解説

詳細については、PathIsUNC に関するページを参照してください。

CPathT::IsUNCServer

パスがサーバーのみの有効な UNC (汎用名前付け規則) パスであるかどうかを判断するには、このメソッドを呼び出します。

BOOL IsUNCServer() const;

戻り値

文字列がサーバー専用の有効な UNC パスである (共有名がない) 場合は TRUE、それ以外の場合は FALSE を返します。

解説

詳細については、PathIsUNCServer に関するページを参照してください。

CPathT::IsUNCServerShare

パスが有効な UNC (汎用名前付け規則) 共有パス (\\ server\ share) であるかどうかを判断するには、このメソッドを呼び出します。

BOOL IsUNCServerShare() const;

戻り値

パスが \\ server\ share の形式である場合は TRUE、それ以外の場合は FALSE を返します。

解説

詳細については、PathIsUNCServerShare に関するページを参照してください。

CPathT::m_strPath

パス。

StringType m_strPath;

解説

StringType は、CPathT のテンプレートパラメーターです。

CPathT::MakePretty

パスをすべて小文字に変換して、パスを一貫した外観にするには、このメソッドを呼び出します。

BOOL MakePretty();

戻り値

パスが変換されている場合は TRUE、それ以外の場合は FALSE を返します。

解説

詳細については、PathMakePretty に関するページを参照してください。

CPathT::MatchSpec

ワイルドカードの一致の種類を含む文字列のパスを検索するには、このメソッドを呼び出します。

BOOL MatchSpec(PCXSTR pszSpec) const;

パラメーター

pszSpec
検索対象のファイルの種類を持つ null 終端文字列へのポインター。たとえば、現在のパスにあるファイルが DOC ファイルであるかどうかをテストするには、pszSpec を "*.doc" に設定する必要があります。

戻り値

文字列が一致する場合は TRUE、それ以外の場合は FALSE を返します。

解説

詳細については、PathMatchSpec に関するページを参照してください。

CPathT::operator +=

この演算子では、文字列をパスに追加します。

CPathT<StringType>& operator+=(PCXSTR pszMore);

パラメーター

pszMore
追加する文字列。

戻り値

更新されたパスを返します。

CPathT::operator const StringType >

この演算子を使用すると、オブジェクトを文字列のように処理できます。

operator const StringType&() const throw();

戻り値

このオブジェクトによって管理されている現在のパスを表す文字列を返します。

CPathT::operator CPathT::PCXSTR

この演算子を使用すると、オブジェクトを文字列のように処理できます。

operator PCXSTR() const throw();

戻り値

このオブジェクトによって管理されている現在のパスを表す文字列を返します。

CPathT::operator StringType &

この演算子を使用すると、オブジェクトを文字列のように処理できます。

operator StringType&() throw();

戻り値

このオブジェクトによって管理されている現在のパスを表す文字列を返します。

CPathT::PCXSTR

定数文字列型。

typedef StringType::PCXSTR PCXSTR;

解説

StringType は、CPathT のテンプレートパラメーターです。

CPathT::PXSTR

文字列型。

typedef StringType::PXSTR PXSTR;

解説

StringType は、CPathT のテンプレートパラメーターです。

CPathT::QuoteSpaces

スペースが含まれている場合にパスを引用符で囲むには、このメソッドを呼び出します。

void QuoteSpaces();

解説

詳細については、PathQuoteSpaces に関するページを参照してください。

CPathT::RelativePathTo

ファイル間またはフォルダー間で相対パスを作成するには、このメソッドを呼び出します。

BOOL RelativePathTo(
    PCXSTR pszFrom,
    DWORD dwAttrFrom,
    PCXSTR pszTo,
    DWORD dwAttrTo);

パラメーター

pszFrom
相対パスの開始点。

dwAttrFrom
pszFrom のファイル属性。この値に FILE_ATTRIBUTE_DIRECTORY が含まれている場合、pszFrom はディレクトリであると見なされます。それ以外の場合、pszFrom はファイルであると見なされます。

pszTo
相対パスの終点。

dwAttrTo
pszTo のファイル属性。この値に FILE_ATTRIBUTE_DIRECTORY が含まれている場合、pszTo はディレクトリであると見なされます。それ以外の場合、pszTo はファイルであると見なされます。

戻り値

成功した場合は TRUE を返し、失敗した場合は FALSE を返します。

解説

詳細については、PathRelativePathTo に関するページを参照してください。

CPathT::RemoveArgs

パスからコマンドライン引数を削除するには、このメソッドを呼び出します。

void RemoveArgs();

解説

詳細については、PathRemoveArgs に関するページを参照してください。

CPathT::RemoveBackslash

パスから末尾の円記号を削除するには、このメソッドを呼び出します。

void RemoveBackslash();

解説

詳細については、PathRemoveBackslash に関するページを参照してください。

CPathT::RemoveBlanks

パスから先頭と末尾のスペースをすべて削除するには、このメソッドを呼び出します。

void RemoveBlanks();

解説

詳細については、PathRemoveBlanks に関するページを参照してください。

CPathT::RemoveExtension

パスからファイル拡張子 (存在する場合) を削除するには、このメソッドを呼び出します。

void RemoveExtension();

解説

詳細については、PathRemoveExtension に関するページを参照してください。

CPathT::RemoveFileSpec

パスの末尾にあるファイル名と円記号を削除するには、このメソッドを呼び出します。

BOOL RemoveFileSpec();

戻り値

成功した場合は TRUE を返し、失敗した場合は FALSE を返します。

解説

詳細については、PathRemoveFileSpec に関するページを参照してください。

CPathT::RenameExtension

パスのファイル名拡張子を新しい拡張子に置き換えるには、このメソッドを呼び出します。ファイル名に拡張子が含まれていない場合は、パスの末尾にこの拡張子が付けられます。

BOOL RenameExtension(PCXSTR pszExtension);

パラメーター

pszExtension
前に "." 文字の付いた新しいファイル名の拡張子。

戻り値

成功した場合は TRUE を返し、失敗した場合は FALSE を返します。

解説

詳細については、PathRenameExtension に関するページを参照してください。

CPathT::SkipRoot

ドライブ文字、または UNC (汎用名前付け規則) サーバーか共有パスの部分を無視してパスを解析するには、このメソッドを呼び出します。

int SkipRoot() const;

戻り値

ルート (ドライブ文字または UNC サーバー/共有) の後のサブパスの先頭位置を返します。

解説

詳細については、PathSkipRoot に関するページを参照してください。

CPathT::StripPath

完全修飾パスとファイル名のパスの部分を削除するには、このメソッドを呼び出します。

void StripPath();

解説

詳細については、PathStripPath に関するページを参照してください。

CPathT::StripToRoot

ルート情報を除くパスのすべての部分を削除するには、このメソッドを呼び出します。

BOOL StripToRoot();

戻り値

パスで有効なドライブ文字が見つかった場合は TRUE、それ以外の場合は FALSE を返します。

解説

詳細については、PathStripToRoot に関するページを参照してください。

CPathT::UnquoteSpaces

パスの先頭と末尾から引用符を削除するには、このメソッドを呼び出します。

void UnquoteSpaces();

解説

詳細については、PathUnquoteSpaces に関するページを参照してください。

CPathT::XCHAR

文字型。

typedef StringType::XCHAR XCHAR;

解説

StringType は、CPathT のテンプレートパラメーターです。

CPathT クラス

構文

パラメーター

メンバー

パブリック typedef

パブリック コンストラクター

パブリック メソッド

パブリック演算子

パブリック データ メンバー

解説

要件

CPathT::AddBackslash

解説

CPathT::AddExtension

パラメーター

戻り値

解説

CPathT::Append

パラメーター

戻り値

解説

CPathT::BuildRoot

パラメーター

解説

CPathT::Canonicalize

解説

CPathT::Combine

パラメーター

解説

CPathT::CommonPrefix

パラメーター

戻り値

解説

CPathT::CompactPath

パラメーター

戻り値

解説

CPathT::CompactPathEx

パラメーター

戻り値

解説

CPathT::CPathT

パラメーター

CPathT::FileExists

戻り値

解説

CPathT::FindExtension

戻り値

解説

CPathT::FindFileName

戻り値

解説

CPathT::GetDriveNumber

戻り値

解説

CPathT::GetExtension

戻り値

CPathT::IsDirectory

戻り値

解説

CPathT::IsFileSpec

戻り値

解説

CPathT::IsPrefix

パラメーター

戻り値

解説

CPathT::IsRelative

戻り値

解説

CPathT::IsRoot

戻り値

解説

CPathT::IsSameRoot

パラメーター

戻り値

解説

CPathT::IsUNC

戻り値

解説

パブリックコンストラクター

パブリックメソッド

パブリックデータメンバー