Extract Method (ExtractionCursor, String, String, ActionType, Boolean)

WebSocketMessage Extract Method (ExtractionCursor, String, String, ActionType, Boolean)

C# API

Extracts text from the message content - everything between (but not including) the specified before and after string objects, and specifying whether the search will be case-sensitive, and what action to take in case of failure.

Namespace: Facilita.Web
Assembly: clrWebBrowser (in clrWebBrowser.dll) Version: 9.5.8.37 (1.0.0.0)

Syntax

C++

Copy to Clipboard Print

public string Extract(
	ExtractionCursor cursor,
	string before,
	string after,
	ActionType failAction,
	bool caseSensitive
)

public string Extract(
	ExtractionCursor cursor,
	string before,
	string after,
	ActionType failAction,
	bool caseSensitive
)

Parameters

cursor: Type: Facilita.Native ExtractionCursor
An ExtractionCursor object to store the success/failure of the action, and the index in the message at which the match was found.

before: Type: System String
This text is searched for in the message content, and the returned string starts immediately after this text occurs in the content.

after: Type: System String
This text is searched for in the message content after the before text has been found, and the returned string ends immediately before this text occurs in the content.

failAction: Type: Facilita.Fc.Runtime ActionType
The action to take if the extract fails.

caseSensitive: Type: System Boolean
true if the search should be case-sensitive.

Return Value

The extracted text, or an empty string if the extract failed.

Remarks

Information about the success/failure of this method will be stored in the ExtractionCursor object passed.

Examples

The following example demonstrates extracting text from a message.

C++

Copy to Clipboard Print

ExtractionCursor cursor = new ExtractionCursor();

// extract the value from the json 
// {"value":"Joe Smith"} 
string extractedText = webSocketMessage.Extract(
                        cursor,
                        "\value\":\"",
                        "\"",
                        ActionType.ACT_ERROR,
                        true);

if (cursor.Succeeded)
{
    WriteMessage(string.Format("The value {0} was found at position {1}", extractedText, cursor.Index));
}

ExtractionCursor cursor = new ExtractionCursor();

// extract the value from the json 
// {"value":"Joe Smith"} 
string extractedText = webSocketMessage.Extract(
                        cursor,
                        "\value\":\"",
                        "\"",
                        ActionType.ACT_ERROR,
                        true);

if (cursor.Succeeded)
{
    WriteMessage(string.Format("The value {0} was found at position {1}", extractedText, cursor.Index));
}