Prev Next

GetTempPath info  Overview  Group

The GetTempPath function retrieves the path of the directory designated for temporary files.

DWORD GetTempPath(

    DWORD nBufferLength,

// size, in characters, of the buffer

    LPTSTR lpBuffer 

// address of buffer for temp. path

   );

Parameters

nBufferLength
Specifies the size, in characters, of the string buffer identified by lpBuffer.
lpBuffer
Points to a string buffer that receives the null-terminated string specifying the temporary file path.

Return Values

If the function succeeds, the return value is the length, in characters, of the string copied to lpBuffer, not including the terminating null character. If the return value is greater than nBufferLength, the return value is the size of the buffer required to hold the path.

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

Remarks

The GetTempPath function gets the temporary file path as follows:

  1. The path specified by the TMP environment variable.

  2. The path specified by the TEMP environment variable, if TMP is not defined.

  3. The current directory, if both TMP and TEMP are not defined.

See Also

GetTempFileName