ExtractList Method (ExtractionCursor, String, String, String, Boolean, Int32)

Response ExtractList Method (ExtractionCursor, String, String, String, Boolean, Int32)

C# API

Extracts a list of items from this Response, specifying whether the search should be case-sensitive, and the maximum number of items to extract.

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

Syntax

C++

Copy to Clipboard Print

public virtual List<string> ExtractList(
	ExtractionCursor cursor,
	string before,
	string after,
	string endAt,
	bool caseSensitive,
	int maxItems
)

public virtual List<string> ExtractList(
	ExtractionCursor cursor,
	string before,
	string after,
	string endAt,
	bool caseSensitive,
	int maxItems
)

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 last match was found.

before: Type: System String
A string before an item to be extracted.

after: Type: System String
A string after an item to be extracted.

endAt: Type: System String
Only return matches that occur before this text in the response.

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

maxItems: Type: System Int32
The maximum number of items to extract.

Return Value

A list containing the extracted string objects.

Remarks

A search is made for multiple occurrences of the before and after markers. The text between each occurrence of the markers is extracted and appended to the list.

Examples

The following example demonstrates extracting multiple strings from a HTML Response.

C++

Copy to Clipboard Print

// The response contains the following text within its body 
// <select> 
//   <option value="volvo">Volvo</option> 
//   <option value="saab">Saab</option> 
//   <option value="mercedes">Mercedes</option> 
//   <option value="audi">Audi</option> 
// </select> 

// Searching from the position marked by the Extraction Cursor, extract the first 2 car model items
ExtractionCursor cursor = new ExtractionCursor();
List<string> matchedstrings = response.ExtractList(cursor, "<option value=\"", "\">", "mercedes", true, 2);
// contents of matchedstrings = ( volvo, saab )

// The response contains the following text within its body 
// <select> 
//   <option value="volvo">Volvo</option> 
//   <option value="saab">Saab</option> 
//   <option value="mercedes">Mercedes</option> 
//   <option value="audi">Audi</option> 
// </select> 

// Searching from the position marked by the Extraction Cursor, extract the first 2 car model items
ExtractionCursor cursor = new ExtractionCursor();
List<string> matchedstrings = response.ExtractList(cursor, "<option value=\"", "\">", "mercedes", true, 2);
// contents of matchedstrings = ( volvo, saab )