IRAPISession::CeGetTempPath

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function gets the path to the directory designated for temporary files on a remote Windows Embedded CE–based device.

Syntax

DWORD CeGetTempPath(
  DWORD nBufferLength,
  LPWSTR lpBuffer 
);

Parameters

• nBufferLength
  [in] Size of lpBuffer in characters.

• lpBuffer
  [out] Reference to a wide string buffer that receives the null-terminated wide string specifying the temporary path. The returned string ends with a backslash (/).

Return Value

The return value is the length, in wide 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, in characters, of the buffer required to hold the path.

If IRAPISession::CeGetTempPath fails, the return value is 0. To get extended error information, call IRAPISession::CeGetLastError and IRAPISession::CeRapiGetError.

Remarks

The IRAPISession::CeGetTempPath 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.

Requirements

See Also

Reference

IRAPISession
IRAPISession::CeGetSpecialFolderPath