Extract Method (ExtractionCursor, String, String, String)

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

C# API

Extracts text from the message content - everything between (but not including) the specified before and after string objects - returning the defaultValue if they cannot be found, and specifying whether the search will be case-sensitive.

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,
	string defaultValue
)

public string Extract(
	ExtractionCursor cursor,
	string before,
	string after,
	string defaultValue
)

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.

defaultValue: Type: System String
The value to return if either the before or after text cannot be found.

Return Value

The extracted text, or defaultValue if the extract failed.

Remarks

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

Note
The search is case-sensitive.

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, defaulting to "Joe Jones" if the value cannot be found 
// {"value":"Joe Smith"} 
string extractedText = webSocketMessage.Extract(
                        cursor,
                        "\value\":\"",
                        "\"",
                        "Joe Jones",
                        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, defaulting to "Joe Jones" if the value cannot be found 
// {"value":"Joe Smith"} 
string extractedText = webSocketMessage.Extract(
                        cursor,
                        "\value\":\"",
                        "\"",
                        "Joe Jones",
                        true);

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