Crestron.SimplSharp

Crestron.SimplSharp is the API to create SIMPL# libraries using Visual Studio 2008 and the Crestron SIMPL# compiler.

A SIMPL# Library (.CLZ) may be referenced from a SIMPL+ program module (.USP), and that referenced from a SIMPL program (.SMW) to create a Series 3 / LOGOS Control System program (.LPZ).

Classes

	Class	Description
	CCriticalSection	Critical Section synchronization between threads.
	CEvent	Class for the crestron Event
	CEventHandle	Base class for the crestron CEvent.
	CMonitor	Methods to provide synchronizes access to objects.
	CMutex	Class for the crestron Mutex
	CNamedEvent	Class for the crestron Named Event A named event can be shared across multiple programs
	CNamedMutex	Class for the crestron Named Mutex A named mutex can be shared across multiple programs
	CrestronConsole	Class to allow access to the Crestron Console.
	CrestronCresnetHelper	Common Cresnet Helper
	CrestronCresnetHelper..::..DiscoveredDeviceElement	One discovered Cresnet device
	CrestronEnvironment	Methods to change the system's Date, Time, and Timezone.
	CrestronEnvironment..::..GC	Controls the system garbage collector, a service that automatically reclaims unused memory.
	CrestronEnvironment..::..SystemInfo	Class containing Crestron control system information
	CrestronEthernetHelper	Crestron Ethernet Helper library
	CrestronFileTransferClient	FileTransferClient class is a File Transfer Class.
	CrestronInvoke	Crestron Invoke class - Provides BeginInvoke functionality
	CrestronMailFunctions	Sending Email through devices.
	CrestronQueue	Fixed-size queue that supports concurrent access and blocking for specified amounts of time while performing operations
	CrestronQueue<(Of <(<'T>)>)>	Fixed-size generic type queue that supports concurrent access and blocking for specified amounts of time while performing operations
	CrestronZIP	Class-wrapper for zip functionality from Utilities DLL
	CTimer	Timer class for the Crestron Simpl#
	Debugger	This class provides debugging features.
	ErrorLog	Class to allow the CustomApplication to log errors
	EthernetAutodiscovery	Ethernet Autodiscovery class
	EthernetAutodiscovery..::..AutoDiscoveredDeviceElement	One Autodiscovered Ethernet device
	EthernetEventArgs	Class for the Ethernet event args. This is what is passed on to the user
	InitialParametersClass	Static class for all initial parameters
	Interlocked	Class for providing atomic operations for variables that are shared by multiple threads.
	IPAddress	Provides an Internet Protocol (IP) address.
	IPEndPoint	Represents a network endpoint as an IP address and a port number.
	ReadOnlyDictionary<(Of <(<'TKey, TValue>)>)>	Wrapper for a dictionary that is read only.
	SimplSharpString	String class to convert between a CrestronString and Simpl # strings Used when interfacing with Simpl Plus
	SocketException	Exception used to throw a socket exception.
	Stopwatch	Object to accurately measure elapsed time.
	Timeout	Timeout for the Crestron Event and Timer class
	XmlException	Exception used when an Xml error occurs.

Structures

	Structure	Description
	CrestronEnvironment..::..CrestronTimeZoneInfo	timezone settings
	CrestronEthernetHelper..::..PortForward	Port forwarding parameters
	CrestronEthernetHelper..::..UserPAT	User PAT (protocol address translation) mapping parameters

Interfaces

	Interface	Description
	ICrestronConsole	Interface to the Crestron Console.

Delegates

	Delegate	Description
	CrestronCresnetHelper..::..LightAndPollDeviceFunctionDelegate	Delegate Signature for the Light and Poll functionality
	CrestronFileTransferClient..::..UserProgressCallBack	CallBack prototype for progress feedback
	CrestronPrintDelegate	Delegate callback for printing to the console
	CrestronSharpHelperDelegate	Delegate for the callback for the Invoke functionality for the Crestron Sharp Helper
	CrestronSimplSharpConsoleAccessDelegate	Delegate callback for printing to the console
	CTimerCallbackFunction	Crestron Timer Callback function
	EthernetEventHandler	Delegate for the Ethernet Event Handler
	InitialParametersClass..::..ResolveHostNameFunctionDelegate	Delegate Signature for the Resolve Host name command
	ProgramStatusEventHandler	Delegate for the program status event handler
	SimplSharpProConsoleCmdFunction	Delegate to hold a ConsoleCommand callback function
	SystemEventHandler	Delegate for the system event handler

Enumerations

	Enumeration	Description
	AddressFamily	Specifies the addressing scheme.
	ConsoleAccessLevelEnum	Console access levels
	CrestronCresnetHelper..::..eCresnetDiscoveryReturnValues	Enum for return codes from the Cresnet discovery operation
	CrestronEthernetHelper..::..ETHERNET_PARAMETER_TO_GET	Enum for ethernet parameters which we can get
	CrestronEthernetHelper..::..ETHERNET_PARAMETER_TO_SET	Enum for ethernet parameters which we can set
	CrestronEthernetHelper..::..PortForwardingUserPatRetCodes	Port forwarding and SetStartingPortForToolBoxCSConnection function return codes
	CrestronFileTransferClient..::..FTCCmdRequest	The cmd requested to perform
	CrestronMailFunctions..::..SendMailErrorCodes	Email Error codes for email
	CrestronStringEncoding	String Encoding passed in by the SIMPL compiler. This was copied from the top of CWCharString.h This is a copy from SplusObjects - so for the time being please do update there also
	CrestronZIP..::..ResultCode	These are the result codes of a zip/unzip operation.
	eEthernetEventType	Enum for the Ethernet Event Types
	eProgramStatusEventType	Enum for the Program Event Types
	eRuntimeEnvironment	Enumeration to define the various runtime environments a SIMPL# module can run in.
	eSystemEventType	Enum for the system events
	EthernetAdapterType	Enums for the Ethernet Adapter Type
	EthernetAutodiscovery..::..eAutoDiscoveryErrors	Enum for return codes from the Autodiscovery operation