Click or drag to resize
Grid Solutions Framework

CommonPhasorServicesGetFilteredStatusMessages Method

Gets a filtered list of status messages.

Namespace: PhasorProtocolAdapters
Assembly: PhasorProtocolAdapters (in PhasorProtocolAdapters.dll) Version: 2.4.182-beta
Syntax
[AdapterCommandAttribute("Gets a filtered list of status messages. StringMatchingMode is one of: 'Exact', 'StartsWith', 'EndsWith', 'Contains', or 'Regex'", 
	new string[] { ... })]
public string GetFilteredStatusMessages(
	StringMatchingMode matchMode,
	string filter,
	bool caseSensitive = false,
	double range = 15,
	string newLine = ""
)
View Source

Parameters

matchMode  StringMatchingMode
Matching mode to apply to status messages. One of: 'Exact', 'StartsWith', 'EndsWith', 'Contains', or 'Regex'.
filter  String
Filter to apply to status messages, if any.
caseSensitive  Boolean  (Optional)
Determines if matching should be case-sensitive.
range  Double  (Optional)
Time range, in minutes, to track filtered status messages.
newLine  String  (Optional)
New line delimiter to use for filtered status messages.

Return Value

String
Filtered list of status messages.
Remarks
Initial call will load status messages from the log and cache them for the specified range. Cached status messages for the specified filter will continue to be updated with matching active status messages for up to one minute over the specified range. If cached status messages are not accessed within one minute, they will be removed from the cache. Subsequent calls for the same filter and range after expiration will reload messages from the log again which may be shorter than the specified range and loading from the log is slower than accessing the cache, so it is recommended to query at intervals more frequent than one minute to keep the cache active.
See Also