FreeEnvironmentStringsA 関数 (processenv.h)

環境文字列のブロックを解放します。

構文

BOOL FreeEnvironmentStringsA(
  LPCH penv
);

パラメーター

penv

環境文字列のブロックへのポインター。 ブロックへのポインターは、 GetEnvironmentStrings 関数を呼び出すことによって取得する必要があります。

戻り値

関数が成功すると、戻り値は 0 以外になります。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

注釈

GetEnvironmentStrings の ANSI バージョンを使用した場合は、必ず ANSI バージョンの FreeEnvironmentStrings を使用してください。 同様に、 GetEnvironmentStrings の Unicode バージョンを使用した場合は、 必ず FreeEnvironmentStrings の Unicode バージョンを使用してください。

例については、「環境変数の 変更」を参照してください。

注意

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

要件

要件
サポートされている最小のクライアント Windows XP [デスクトップ アプリ | UWP アプリ]
サポートされている最小のサーバー Windows Server 2003 [デスクトップ アプリのみ | UWP アプリ]
対象プラットフォーム Windows
ヘッダー processenv.h (Windows Server 2003、Windows Vista、Windows 7、Windows Server 2008 Windows Server 2008 R2 の Windows.h を含む)
Library Kernel32.lib
[DLL] Kernel32.dll

関連項目

環境変数

GetEnvironmentStrings