FtpGetCurrentDirectoryA function (wininet.h)
Retrieves the current directory for the specified FTP session.
Syntax
BOOL FtpGetCurrentDirectoryA(
[in] HINTERNET hConnect,
[out] LPSTR 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
The wininet.h header defines FtpGetCurrentDirectory as an alias that 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 is 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 |