| |
| INT GetCommandResult( |
| |
UINT nClientId, |
|
| |
LPTSTR lpszResult, |
|
| |
INT nMaxLength |
|
| ); |
| INT GetCommandResult( |
| |
UINT nClientId, |
|
| |
CString& strResult |
|
| ); |
Return the result code and description for the last command issued
by the client.
Parameters
- nClientId
- An unsigned integer which uniquely identifies the client
session.
- lpszResult
- A pointer to a string buffer that will contain the description
of the result code. The string buffer will be null terminated up to
the maximum number of characters specified by the caller. This parameter
can be NULL if this information is not required. An alternate version of
this method accepts a CString
object if it is available.
- nMaxLength
- An integer value that specifies the maximum number of characters
that can be copied into the string buffer. If the lpszResult
parameter is NULL, this value should be zero.
Return Value
An integer value which specifies the result code for the last
command issued by the client. A return value of zero indicates that
the command has not completed and there is no result code available.
Remarks
The GetCommandResult method is used to determine the
result of the last command that was issued by the client and is
typically called in the OnResult event handler. This method
should only be called after a command has been processed or the
SendResponse method has been called.
The result code is a three-digit integer value that indicates the
success or failure of a command. Whenever a client sends a command to
the server, the server must respond with this numeric code, and
optionally a text message that further describes the result. The text
message may be a single line, or it may span multiple lines, with each
line of text terminated by a carriage return and linefeed. Result
codes are generally broken down into the following categories:
| Result Code |
Description |
| 100-199 |
Result codes in this range indicate that the
requested action is being initiated, and the client should expect
another reply from the server before proceeding. This is normally
used with file transfers, indicating to the client that the data
transfer has started. |
| 200-299 |
Result codes in this range indicate that the server
has successfully completed the requested action. One exception is
the 202 result code which indicates that the command is not
implemented, but the client should not consider this to be an
error condition. |
| 300-399 |
Result codes in this range indicate that the
requested action cannot complete until additional information is
provided to the server. This is normally used with commands that
require a specific sequence to complete. For example, the server
will send the 331 result code in response to the USER command,
which tells the client that it must send the PASS command to
complete the authentication process. |
| 400-499 |
Result codes in this range indicate that the
requested action did not take place, but the error condition is
temporary and may be attempted again. This error response is
usually the result of a failed authentication attempt or a file
transfer that could not complete. |
| 500-599 |
Result codes in this range indicate that the requested action
did not take place and the failure is permanent. The client should
not attempt to send the command again. This error response is
usually the result of an invalid command name, a syntax error or
the client not having the appropriate access rights to a resource. |
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: csftsv10.lib
Unicode: Implemented as Unicode and ANSI versions.
See Also
SendResponse,
OnResult
|
|