Click or drag to resize

CrestronConsoleAddNewConsoleCommand(SimplSharpProConsoleCmdFunction, String, String, ConsoleAccessLevelEnum, Boolean) 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#
public static bool AddNewConsoleCommand(
	SimplSharpProConsoleCmdFunction userFunction,
	string userCmdName,
	string userCmdHelp,
	ConsoleAccessLevelEnum userAccess,
	bool bIsCommandHidden
)

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.
bIsCommandHidden  Boolean
if true the command will be hidden and will not show up in help user

Return Value

Boolean
true if the operation succeeds; otherwise, false.
Exceptions
ExceptionCondition
ArgumentExceptionVerify the Command name does not contain spaces.
ArgumentOutOfRangeException Specified parameter is out of range.

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also