Bookmark_SetProperty

Top  Previous  Next

Sub Bookmark_SetProperty($property As String, $value As String)

 

Changes a bookmark configuration.

 

Parameters

 

$property ... String value. Bookmark property that should be changed.
$value ... String value. Value that should be assigned.

 

Valid values of $property:

Value

Description

check_url

Defines the URL that should be checked.

 

Info: The bookmark properties are not changed permanently, only temporarily for the current check. You will not see these changes in the bookmark properties. This function is typically used in the event function Wsw_BeforeCheck.

main_url

Replaces the main URL in the bookmark properties.

 

Info: This replaces the URL in the bookmark properties permanently.

pagetype

Overrides the page type that should be used for the check.

Valid values for pagetype are:

autodetect, html, text, rss, atom, binary

 

Info: The bookmark properties are not changed permanently, only temporarily for the current check. You will not see these changes in the bookmark properties. This function is typically used in the event function Wsw_BeforeCheck.

checkmethod

Overrides the checking method that should be used for the check.

Valid values for checkmethod are:

automatic, content, date, size

 

Info: The bookmark properties are not changed permanently, only temporarily for the current check. You will not see these changes in the bookmark properties. This function is typically used in the event function Wsw_BeforeCheck.

name

Writes the bookmark name.

note

Writes the bookmark note.

infofield1

Writes the additional info field #1.

infofield2

Writes the additional info field #2.

infofield3

Writes the additional info field #3.

MarkAsRead

Marks a changed bookmark as read.

Valid value is: "1"

 

Example: Bookmark_SetProperty(Handle, "MarkAsRead", "1")

dont_check_minutes

Temporarily disable bookmark checking for the specified number of minutes (must be specified within quotes).

 

Example: Bookmark_SetProperty(Handle, "dont_check_minutes", "10")

ignore_filter

Defines an ignore filter that is used temporarily for the check. More filters must be separated with a carriage return / line feed (CRLF)

 

Example: Bookmark_SetProperty(Handle, "ignore_filter", "filter1" + CRLF + "filter2")

 

Info: The bookmark properties are not changed permanently, only temporarily for the current check. You will not see these changes in the bookmark properties. This function is typically used in the event function Wsw_BeforeCheck.

watch_filter

Defines a watch filter that is used temporarily for the check. More filters must be separated with a carriage return / line feed (CRLF)

 

Example: Bookmark_SetProperty(Handle, "watch_filter", "filter1" + CRLF + "filter2")

 

Info: The bookmark properties are not changed permanently, only temporarily for the current check. You will not see these changes in the bookmark properties. This function is typically used in the event function Wsw_BeforeCheck.

filter_ignore_removed_content

Enables the special filter "Ignore removed elements".

Valid values are: "0" and "1"

 

Example: Bookmark_SetProperty(Handle, "filter_ignore_removed_content", "1")

 

Info: The bookmark properties are not changed permanently, only temporarily for the current check. You will not see these changes in the bookmark properties. This function is typically used in the event function Wsw_BeforeCheck.

 

Example:

Sub Wsw_BeforeCheck()

   

   ' Change bookmark pagetype to "text"

   Bookmark_SetProperty("pagetype", "text")

End Sub