PathUnExpandEnvStringsA 関数 (shlwapi.h)

完全修飾パス内の特定のフォルダー名を、関連付けられている環境文字列に置き換えます。

構文

BOOL PathUnExpandEnvStringsA(
  [in]  LPCSTR pszPath,
  [out] LPSTR  pszBuf,
  [in]  UINT   cchBuf
);

パラメーター

[in] pszPath

型: LPCTSTR

展開しないパスを含む最大長MAX_PATHの null で終わる文字列へのポインター。

[out] pszBuf

型: LPTSTR

このメソッドが正常に返されると、展開されていない文字列を受け取るバッファーへのポインター。 返された文字列を保持するのに十分な大きさになるように、このバッファーのサイズを MAX_PATH に設定する必要があります。

[in] cchBuf

型: UINT

pszBuf バッファー内のサイズ (文字単位)。

戻り値

型: BOOL

成功した場合 TRUE を返します。それ以外の場合は、FALSEを します。

備考

次のフォルダー パスは、同等の環境文字列に置き換えられます。

フォルダ	環境文字列
[すべてのユーザー] プロファイル フォルダー	%ALLUSERSPROFILE%
現在のユーザーのアプリケーション データ フォルダー (Windows Vista 以降のみ)。	%APPDATA%
システム名	%COMPUTERNAME%
Program Files フォルダー	%ProgramFiles%
システム ルート フォルダー	%SystemRoot%
システム ドライブ文字	%SystemDrive%
現在のユーザーのプロファイル フォルダー	%USERPROFILE%

 

%APPDATA% と %USERPROFILE% は、呼び出しを行うユーザーに対して相対的です。 ユーザーがサービスから偽装されている場合、この関数は機能しません。 アクセス制御の問題の詳細については、「Access Control」を参照してください。

 

上記の表に示す環境変数が、すべてのシステムで設定されているわけではありません。 環境変数が設定されていない場合は、展開されません。

手記

shlwapi.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして PathUnExpandEnvStrings を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。

必要条件

要件	価値
サポートされる最小クライアント	Windows 2000 Professional、Windows XP [デスクトップ アプリのみ]
サポートされる最小サーバー	Windows 2000 Server [デスクトップ アプリのみ]
ターゲット プラットフォーム の	ウィンドウズ
ヘッダー	shlwapi.h
ライブラリ	Shlwapi.lib
DLL	Shlwapi.dll (バージョン 5.0 以降)

関連項目

DoEnvironmentSubst