HostedBACnetDeviceRemoveObject(BACnetObject, Int32) Method |
Removes the specified host object from the corresponding host objects collection, with user settable timeout option. This function also validates the object parameters passed.
Success will be returned if the object is removed successfully, otherwise an exception is thrown that tells what kind of error found.
Namespace: Crestron.SimplSharpProAssembly: SimplSharpPro (in SimplSharpPro.dll) Version: 2.21.121
Syntaxpublic override bool RemoveObject(
BACnetObject paramObject,
int paramResponseTimeout
)
Parameters
- paramObject BACnetObject
- Object to be removed from the corresponding hosted device object collection.
- paramResponseTimeout Int32
- Maximum wait time in ms required for the object to be removed from the BACnet stack. Set the timeout value to Infinite to wait indefinitely. The minimum value to be entered is 10000.
Return Value
BooleanReturns 'true' if the object is removed successfully, otherwise an exception is thrown.
Exceptions
RemarksThis method will block pending a response. It is recommended to not invoke this method from within a event handler. Please launch a timer/thread to remove a host object.
Also – this method not be called from the control system constructor.
Version Information
.NET
Supported in: 6.0
.NET Compact Framework
Supported in: 3.5
See Also