FtpGetCurrentDirectory function

Retrieves the current directory for the specified FTP session.

Syntax


BOOL FtpGetCurrentDirectory(
  _In_    HINTERNET hConnect,
  _Out_   LPTSTR    lpszCurrentDirectory,
  _Inout_ LPDWORD   lpdwCurrentDirectory
);

Parameters

hConnect [in]: Handle to an FTP session.
lpszCurrentDirectory [out]: Pointer to a null-terminated string that receives the absolute path of the current directory.
lpdwCurrentDirectory [in, out]: 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).

Requirements

Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Header	Wininet.h
Library	Wininet.lib
DLL	Wininet.dll
Unicode and ANSI names	FtpGetCurrentDirectoryW (Unicode) and FtpGetCurrentDirectoryA (ANSI)