:Command()
Class
Syntax
:Command( cCommand, [cParam], [hSession] -> lSuccess
Parameters
|
|
cCommand |
Command to execute on the remote server. |
|
|
cParam |
Optional. Parameters required for cCommand. If the command requires more than one parameter, then they should be combined into a single string, with a space seperating each parameter. |
|
|
hSession |
Optional: If hSession is not passed, the value in :Session will be used |
Return
Logical indicating Success.
Returns .T. if the operation succeeds, otherwise returns .F.
To get more information about the error, see :nErr and :cErr.
Description
The :Command method sends a command to the remote server, and returns the result code back to the caller. This method is typically used for site-specific commands not directly supported by the API.
To see the remote server's response, see :GetResultCode() and :GetResultString().
A list of valid commands can be found in the technical specification for the protocol.
Many servers will list supported commands when the HELP command is used.
See Also
:GetResultCode(), :GetResultString()