FtpGetCurrentDirectoryW function (wininet.h)

Article
02/22/2024

Retrieves the current directory for the specified FTP session.

Syntax

BOOL FtpGetCurrentDirectoryW(
  [in]      HINTERNET hConnect,
  [out]     LPWSTR    lpszCurrentDirectory,
  [in, out] LPDWORD   lpdwCurrentDirectory
);

Parameters

[in] hConnect

Handle to an FTP session.

[out] lpszCurrentDirectory

Pointer to a null-terminated string that receives the absolute path of the current directory.

[in, out] lpdwCurrentDirectory

Pointer to a variable that specifies the length of the buffer, in TCHARs. The buffer length must include room for a terminating null character. Using a length of MAX_PATH is sufficient for all paths. When the function returns, the variable receives the number of characters copied into the buffer.

Return value

Returns TRUE if successful, or FALSE otherwise. To get a specific error message, call GetLastError.

Remarks

If the lpszCurrentDirectory buffer is not large enough, lpdwCurrentDirectory receives the number of bytes required to retrieve the full, current directory name.

Like all other aspects of the WinINet API, this function cannot be safely called from within DllMain or the constructors and destructors of global objects.

Note WinINet does not support server implementations. In addition, it should not be used from a service. For server implementations or services use Microsoft Windows HTTP Services (WinHTTP).

Note

The wininet.h header defines FtpGetCurrentDirectory as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	wininet.h
Library	Wininet.lib
DLL	Wininet.dll