CPathT クラス

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

重要

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

構文

template <typename StringType>
class CPathT

パラメーター

StringType
パスに使用する ATL/MFC 文字列クラス (「 CStringT」を参照)。

メンバー

パブリック typedef

名前 説明
CPathT::P CXSTR 定数文字列型。
CPathT::P XSTR 文字列型。
CPathT:: XCHAR 文字型。

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

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

パブリック メソッド

名前 説明
CPathT:: AddBackslash ラッシュ パスの正しい構文を作成するために、このメソッドを呼び出して、文字列の末尾に円記号を追加します。
CPathT:: AddExtension ファイル拡張子をパスに追加するには、このメソッドを呼び出します。
CPathT:: Append 現在のパスに文字列を追加するには、このメソッドを呼び出します。
CPathT:: BuildRoot 指定したドライブ番号からルートパスを作成するには、このメソッドを呼び出します。
CPathT:: 正規化 パスを正規の形式に変換するには、このメソッドを呼び出します。
CPathT:: 結合 ディレクトリ名を表す文字列と、ファイルパス名を表す文字列を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:: Isデストラクタサーバー パスがサーバーの有効な UNC (汎用名前付け規則) パスであるかどうかを確認するには、このメソッドを呼び出します。
CPathT:: Isデストラクタ Servershare パスが有効な UNC (汎用名前付け規則) 共有パス (サーバー共有) であるかどうかを確認するには、このメソッドを呼び出し \ \ \ ます。
CPathT:: MakePretty パスをすべて小文字に変換して、パスを一貫した外観にするには、このメソッドを呼び出します。
CPathT:: MatchSpec ワイルドカードの一致の種類を含む文字列のパスを検索するには、このメソッドを呼び出します。
CPathT:: QuoteSpaces スペースが含まれている場合は、このメソッドを呼び出して、パスを引用符で囲みます。
CPathT:: RelativePathTo ファイルまたはフォルダー間で相対パスを作成するには、このメソッドを呼び出します。
CPathT:: RemoveArgs パスからコマンドライン引数を削除するには、このメソッドを呼び出します。
CPathT:: RemoveBackslash ラッシュ パスから末尾の円記号を削除するには、このメソッドを呼び出します。
CPathT:: RemoveBlanks パスから先頭と末尾の空白をすべて削除するには、このメソッドを呼び出します。
CPathT:: RemoveExtension パスからファイル拡張子を削除するには、このメソッドを呼び出します (存在する場合)。
CPathT:: RemoveFileSpec パスの末尾にあるファイル名と円記号を削除するには、このメソッドを呼び出します。
CPathT:: RenameExtension パスのファイル名拡張子を新しい拡張子に置き換えるには、このメソッドを呼び出します。 ファイル名に拡張子が含まれていない場合は、文字列の末尾に拡張子が付けられます。
CPathT:: SkipRoot パスを解析するには、ドライブ文字または UNC サーバー/共有パスの部分を無視して、このメソッドを呼び出します。
CPathT:: という Ppath 完全修飾パスとファイル名のパス部分を削除するには、このメソッドを呼び出します。
CPathT:: トーラス ルート情報を除くパスのすべての部分を削除するには、このメソッドを呼び出します。
CPathT:: UnquoteSpaces パスの先頭と末尾から引用符を削除するには、このメソッドを呼び出します。

パブリック演算子

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

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

名前 説明
CPathT:: m_strPath パス。

解説

CPathCPathA 、および 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:: 正規化

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

void Canonicalize();

解説

詳細については、「 Pathcanonicalize」を参照してください。

CPathT:: 結合

ディレクトリ名を表す文字列と、ファイルパス名を表す文字列を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:: Isデストラクタサーバー

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

BOOL IsUNCServer() const;

戻り値

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

解説

詳細については、「 Pathisを使用しないサーバー」を参照してください。

CPathT:: Isデストラクタ Servershare

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

BOOL IsUNCServerShare() const;

戻り値

パスがサーバー共有の形式である場合 \ \ \ は TRUE、それ以外の場合は FALSE を返します。

解説

詳細については、「 Pathisのサーバー共有」を参照してください。

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::P CXSTR

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

operator PCXSTR() const throw();

戻り値

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

CPathT:: operator StringType &

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

operator StringType&() throw();

戻り値

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

CPathT::P CXSTR

定数文字列型。

typedef StringType::PCXSTR PCXSTR;

解説

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

CPathT::P XSTR

文字列型。

typedef StringType::PXSTR PXSTR;

解説

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

CPathT:: QuoteSpaces

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

void QuoteSpaces();

解説

詳細については、「 PathQuoteSpaces」を参照してください。

CPathT:: RelativePathTo

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

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

パラメーター

psz
相対パスの開始。

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:: という Ppath

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

void StripPath();

解説

詳細については、「 Pathの Ppath」を参照してください。

CPathT:: トーラス

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

BOOL StripToRoot();

戻り値

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

解説

詳細については、「 Pathstriptoroot」を参照してください。

CPathT:: UnquoteSpaces

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

void UnquoteSpaces();

解説

詳細については、「 PathUnquoteSpaces」を参照してください。

CPathT:: XCHAR

文字型。

typedef StringType::XCHAR XCHAR;

解説

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

関連項目

クラス
CStringT クラス