Tries to get the value of a watched attribute as ReadOnlyCollection<(Of <(<'T>)>)> of String.

Note: This method is supported for IC Server version 2016 R4 and beyond.

Namespace: ININ.IceLib.Interactions
Assembly: ININ.IceLib.Interactions (in ININ.IceLib.Interactions.dll) Version: 0.0.0.0 (22.3.0.218)

Syntax

C#
public bool TryGetWatchedStringsAttribute(
	string attributeName,
	out ReadOnlyCollection<string> values
)
Visual Basic
Public Function TryGetWatchedStringsAttribute ( _
	attributeName As String, _
	<OutAttribute> ByRef values As ReadOnlyCollection(Of String) _
) As Boolean

Parameters

attributeName
Type: System..::..String
The attribute name.
values
Type: System.Collections.ObjectModel..::..ReadOnlyCollection<(Of <(<'String>)>)>%
The attribute value.

Return Value

trueTruetruetrue (True in Visual Basic) if the attribute is being watched, and was successfully retrieved; otherwise, falseFalsefalsefalse (False in Visual Basic).

Remarks

Note
Accessing this property before a watch is started which includes this property raises a NotCachedException. A watch must be started first. For more information on watches see How Watches Work.
Note
For information about the standard attributes defined by the Interaction Center System, see the "Interaction Attributes Technical Reference" in the Interaction Center Documentation Library. This document describes the attributes and the format of their values.
Note
GetWatchedStringsAttribute(String) is the preferred method of retrieving a watched attribute as a collection of strings. Using this method will suppress the NotCachedException if the specified attribute is not being watched.

Exceptions

ExceptionCondition
System..::..ArgumentNullExceptionAn argument was nullNothingnullptra null reference (Nothing in Visual Basic).

Version Information

Supported for IC Server version 2016 R4 and beyond.

See Also