Home » API » Documentation » API » Scraping Engine API » scrapeableFile

removeHTTPParameter

void scrapeableFile.removeHTTPParameter ( int sequence )
void scrapeableFile.removeHTTPParameter ( String key ) (professional and enterprise editions only)

Description

Dynamically removes an HTTPParameter. The order of the remaining parameters are adjusted immediately.

Parameters

  • sequence The ordered location of the parameter.
  • key The key identifying the HTTP parameter to be removed.

Return Values

Returns void.

Change Log

Version Description
4.5 Available for all editions.
5.5.32a: Added method call that takes a String. Available for Professional and Enterprise editions.

If calling this method more than once in the same script, when used in conjunction with the addHTTPParameter method, it is important to keep track of how the list is reordered before calling either method again.

Calling this method will have no effect unless it's invoked before the file is scraped.

This method can be used for both GET and POST parameters.

Examples

Remove HTTP parameter

 // In a script called "Before file is scraped"

 // Removes the eighth HTTP parameter from the current file.
 scrapeableFile.removeHTTPParameter( 8 );

See Also

  • addHTTPParameter() [scrapeableFile] - Adds an HTTP Parameter to the request that will be made by the scrapeable file
  • removeAllHTTPParameters() [scrapeableFile] - Remove all the HTTP Parameters from the request that will be made by the scrapeable file
scraper on 07/16/2010 at 4:55 pm