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。

解説

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

Folder 環境文字列
[すべてのユーザー] プロファイル フォルダー %ALLUSERSPROFILE%
現在のユーザーのアプリケーション データ フォルダー (Windows Vista 以降のみ)。 %APPDATA%
システム名 %COMPUTERNAME%
Program Files フォルダー %ProgramFiles%
システム ルート フォルダー %SystemRoot%
システム ドライブ文字 %SystemDrive%
現在のユーザーのプロファイル フォルダー %USERPROFILE%
 
メモ %APPDATA% と %USERPROFILE% は、呼び出しを行っているユーザーに対して相対的です。 ユーザーがサービスから偽装されている場合、この関数は機能しません。 アクセス制御の問題の詳細については、「Access Control」を参照してください。
 
上記の表に示す環境変数が、すべてのシステムで設定されているわけではありません。 環境変数が設定されていない場合は、展開されません。

注意

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

要件

   
サポートされている最小のクライアント Windows 2000 Professional、Windows XP [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー shlwapi.h
Library Shlwapi.lib
[DLL] Shlwapi.dll (バージョン 5.0 以降)

関連項目

DoEnvironmentSubst