| INT GetResultString( |
| |
LPTSTR lpszResult, |
|
| |
INT cbResult |
|
| ); |
| INT GetResultString( |
| |
CString& strResult |
|
| ); |
The GetResultString method returns the last message sent by
the server along with the result code.
Parameters
- lpszResult
- A pointer to the buffer that will contain the result string
returned by the server. An alternate form of the method
accepts a CString argument which will contain the result
string returned by the server.
- cbResult
- The maximum number of characters that may be copied into the
result string buffer, including the terminating null character.
Return Value
If the method succeeds, the return value is the length of the
result string. If a value of zero is returned, this means that no
result string was sent by the server. If the method fails, the
return value is FTP_ERROR. To get extended error information, call
GetLastError.
Remarks
The GetResultString method is most useful when an error
occurs because the server will typically include a brief
description of the cause of the error. This can then be parsed by the
application or displayed to the user. The result string is updated
each time the client sends a command to the server and then
calls GetResultCode to obtain the result code for the
operation.
Requirements
Minimum Desktop Platform: Windows 7 (Service Pack 1)
Minimum Server Platform: Windows Server 2008 R2 (Service Pack 1)
Header File: cstools10.h
Import Library: csftpv10.lib
Unicode: Implemented as Unicode and ANSI versions.
See Also
Command,
GetResultCode
|