Click or drag to resize

ICrestronConsoleAddNewConsoleCommand(SimplSharpProConsoleCmdFunction, String, String, ConsoleAccessLevelEnum) Method

Function for the user to add console commands to the system.

Namespace: Crestron.SimplSharp
Assembly: SimplSharpHelperInterface (in SimplSharpHelperInterface.dll) Version: 2.21.121
Syntax
C#
bool AddNewConsoleCommand(
	SimplSharpProConsoleCmdFunction userFunction,
	string userCmdName,
	string userCmdHelp,
	ConsoleAccessLevelEnum userAccess
)

Parameters

userFunction  SimplSharpProConsoleCmdFunction
Callback function the command will call.
userCmdName  String
Name of the console command. Spaces are not permitted.
userCmdHelp  String
Information on the console command.
userAccess  ConsoleAccessLevelEnum
Authentication level of the command.

Return Value

Boolean
true if the operation succeeds; otherwise, false.
Exceptions
ExceptionCondition
ArgumentExceptionVerify the Command name does not contain spaces.
NotSupportedExceptionThis feature is only available in SIMPL# Pro

Version Information

.NET Compact Framework

Supported in: 3.5
See Also