windows_programming_notes.nbk: Home | Index | Next Page: GET_APPCOMMAND_LPARAM | Previous Page: FormatMessage

 FreeEnvironmentStrings

Frees a block of environment strings.

Syntax

    BOOL WINAPI FreeEnvironmentStrings(
      __in  LPTCH lpszEnvironmentBlock
    );

Parameters

• lpszEnvironmentBlock
  A pointer to a block of environment strings. The pointer to the block must be obtained by calling the GetEnvironmentStrings function.

Return Value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero To get extended error information, call GetLastError.

Remarks

If you used the ANSI version of GetEnvironmentStrings, be sure to use the ANSI version of FreeEnvironmentStrings. Similarly, if you used the Unicode version of GetEnvironmentStrings, be sure to use the Unicode version of FreeEnvironmentStrings.

Requirements

• Client Requires Windows Vista, Windows XP, or Windows 2000 Professional.
• Server Requires Windows Server 2008, Windows Server 2003, or Windows 2000 Server.
• Header Declared in Winbase.h; include Windows.h.
• Library Use Kernel32.lib.
• DLL Requires Kernel32.dll.
• Unicode Implemented as FreeEnvironmentStringsW (Unicode) and FreeEnvironmentStringsA (ANSI).

windows_programming_notes.nbk: Home | Index | Next Page: GET_APPCOMMAND_LPARAM | Previous Page: FormatMessage

Notebook exported on Monday, 7 July 2008, 18:56:50 PM Eastern Daylight Time