Extract Method (ExtractionCursor, String, String, SearchFlags)

Response Extract Method (ExtractionCursor, String, String, SearchFlags)

C# API

Extracts text from the response content - everything between (but not including) the specified before and after string objects - returning an empty string if they cannot be found.

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,
	SearchFlags matchFlags
)

public string Extract(
	ExtractionCursor cursor,
	string before,
	string after,
	SearchFlags matchFlags
)

Parameters

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

before: Type: System String
This text is searched for in the response 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 response content after the before text has been found, and the returned string ends immediately before this text occurs in the content.

matchFlags: Type: Facilita.Web SearchFlags
An SearchFlags enumerated value to indicate what should be searched: SEARCH_IN_BODY, SEARCH_IN_HEADERS or SEARCH_IN_BOTH.

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.

Note
The search is case-sensitive.

The matchFlags parameter determines if the response html body, response header(s) or both are searched.

Examples

The following example demonstrates extracting text from a HTML Response.

C++

Copy to Clipboard Print

Response response = request.Send();
ExtractionCursor cursor = new ExtractionCursor();

// extract the value from the HTML body text, the response header(s) or both: 
// BODY:      <script type=\"text/JavaScript\" src=\"javascript/common.js\"></script>\<noscript>You do not have Javascript enabled.</noscript>\clientSrc=195.234.243.132;\ 
// HEADER(S): Cache-Control: no-cache, no-store\r\nContent-Type: text/html;charset=UTF-8\r\nContent-Encoding: gzip\r\nExpires: Thu, 01 Jan 1970 00:00:00 GMT\r\nSet-Cookie: clientSrc=195.234.243.264;Path=/;Secure\r\n 
string extractedText = response.Extract(
                        cursor,
                        "clientSrc=",
                        ";",
                        SearchFlags.SEARCH_IN_BODY | SearchFlags.SEARCH_IN_HEADERS | SearchFlags.SEARCH_IN_BOTH);

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

Response response = request.Send();
ExtractionCursor cursor = new ExtractionCursor();

// extract the value from the HTML body text, the response header(s) or both: 
// BODY:      <script type=\"text/JavaScript\" src=\"javascript/common.js\"></script>\<noscript>You do not have Javascript enabled.</noscript>\clientSrc=195.234.243.132;\ 
// HEADER(S): Cache-Control: no-cache, no-store\r\nContent-Type: text/html;charset=UTF-8\r\nContent-Encoding: gzip\r\nExpires: Thu, 01 Jan 1970 00:00:00 GMT\r\nSet-Cookie: clientSrc=195.234.243.264;Path=/;Secure\r\n 
string extractedText = response.Extract(
                        cursor,
                        "clientSrc=",
                        ";",
                        SearchFlags.SEARCH_IN_BODY | SearchFlags.SEARCH_IN_HEADERS | SearchFlags.SEARCH_IN_BOTH);

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