Functions With No Return Value

   Previous topic Next topic  

These functions have no return value, and may also be referred to as "procedures".

activateCategory(int exp categoryid, int exp activate);

•categoryid - the category id of the category to activate or deactivate

•activate - if non-zero, activates the category; if zero, deactivates the category

•To deactivate all categories, use -1 for categoryid and 0 for activate

•This procedure does nothing if you try to deactivate a category that is not active or activate a category that doesn't exist.

•This function is implemented only in CSE HTML Validator v4.00 and later.

activateCategories(int exp
 activate[, int exp categoryid...]);

•activate - if non-zero, activates the category; if zero, deactivates the category

•categoryid - the category id of the category to activate or deactivate

•This procedure does nothing if you try to deactivate a category that is not active or activate a category that doesn't exist.

•This function is implemented only in CSE HTML Validator v5.4940 and later.

addLink(int exp flags[, string exp linktype]
 [, string exp attname][, int exp attindex]);

•Add a link for link checking. Adds the link to the $links array and the link type to the $linkstypes array.

•flags

•1 - supply the attname parameter to add the attribute value of attname for link checking

•2 - supply the linktype parameter to manually specify the link type, otherwise it is automatically generated (examples: "A HREF", "IMG SRC", etc.)

•4 - add the attribute value of the current attribute being checked for link checking (use in attribute and attribute value programs only)

•8 - supply the attindex parameter to add the attribute value of the attribute with index attindex for link checking

•This function is implemented only in CSE HTML Validator v11.0104 and later.

checkAttributes(int exp flags,
 string exp att1[, string exp att2...]);

•flags

•1 - display a standard warning message if any of the listed attributes have values that have leading or trailing spaces; if a listed attribute does not exist then it is treated as though it does not have leading or trailing spaces.

•2 - add "[33] " to the beginning of the standard warning message.

•attx - an attribute

•This function is implemented only in CSE HTML Validator v4.0320 and later.

checkStyle(int exp flags);

•flags

•1 - check the "style" attribute value if style checking is enabled; if there is no "style" attribute in the current tag, then this function does nothing.

•2 - check the style declarations contained in the tag; use this only in an end tag name program like the end tag name program for the "script" element.

•This function does not do anything if style checking is not enabled.

•This function is implemented only in CSE HTML Validator v4.9910 and later.

endCurrentElement();

•Call to simulate an end tag for the current element.

•This function is implemented only in CSE HTML Validator v11.00 and later.

 

runLinkCheckProgramForTags(string exp
 tagname1[, string exp tagname2...]);

•Specifies the elements that cause the link check tag name program to execute during a link check. Using this function results in a significant performance improvement compared to not using this function.

•This function can only be used in the link check tag name program so it has no use or effect in other tag name programs or when validating.

•This function is implemented only in CSE HTML Validator v4.4910 and later.

setClosed(int exp id);

•id - the ID number of the tag name to mark as closed; this ID is the ID of the tag name in the document structure, not in the configuration

setValidated(int exp index, int exp what);

•index - the index of the attribute and/or attribute value to set

•what - what to set (specifies to set the attribute, the attribute value, or both)

•SET_ATTRIBUTE - set the attribute to be valid so that most (not all) error messages are not generated for the attribute

•SET_ATTVALUE - set the attribute value to be valid so that no error messages are generated for the attribute value

•SET_ATTANDATTVALUE - same as SET_ATTRIBUTE+SET_ATTVALUE (New v10.9926)

•SET_NOCASECHECK - do not do a case check on the tag or attribute name (case checks are done for XHTML based documents) (New v10.9912)

•SET_NOVALUEREQUIRED - do not generate an error because the attribute does not have an equals sign followed by a value (New v10.9912)

•To set both attribute and value validated at the same time, use SET_ATTRIBUTE+SET_ATTVALUE or SET_ATTANDATTVALUE

•In versions previous to v10.99, a "$" may need to be pre-pended to the what values, and SET_NOCASECHECK and SET_NOVALUEREQUIRED are not valid

setValueString(int exp valueidentifier,
 string exp value[, string exp value2,
 string exp value3...]);

•valueidentifier - tells the function which string value to set

•1 - a string that is used to override the default warning string about not using a space character before a '/' character in XML style empty tags

•2 - add the value string to the list of validation modes; good to use in the onConfigLoad() function to specify new validation modes. The first string added will have a CSEJOBSUBTYPE of 1, the second string added will have a CSEJOBSUBTYPE of 2, etc. (New v4.5091)

•3 - add the value string to the list of recognized doctypes; good to use in the onConfigLoad() function; example: setValueString(3,'!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html401/strict.dtd"');; also see 22 (New v4.9940)

•4 - set the DOCTYPE tag name program to value; good to use in the onConfigLoad() function; also see 19 (New v4.9940)

•5 - set the XML declaration tag name program to value; good to use in the onConfigLoad() function (New v5.4910)

•6 - set the comment tag name program to value; good to use in the onConfigLoad() function (New v5.4910)

•7 - set the ignore to end tag name program to value; good to use in the onConfigLoad() function; program is run when a nested ignore to end tag is encountered (New v5.4920)

•8 - limit messages to those having a category name that matches value (case insensitive); can be called repeatedly to limit messages to multiple categories (New v5.4930)

•9 - set the entity tag name program to value; good to use in the onConfigLoad() function (New v5.4940)

•10 - add the value string to the list of recognized "web-safe" typefaces; good to use in the onConfigLoad() function; add an empty string to clear the list (New v7.9910)

•11 - add the value string to the list of recognized typefaces; good to use in the onConfigLoad() function if you are using an unusual typeface that CSE HTML Validator does not recognize (New v7.9910)

•12 - add the value string to the list of ignored CSS properties; if a property has already been added to the list then it is not added again; good to use in the onUnknownCSSPropertyMessage() function; this list is used to generate a validator  message listing the ignored CSS properties (New v7.9910)

•13 - add the value string to the list of DOCTYPE strings that can be validated using a DTD and nsgmls but not CSE HTML Validator's own validation engine (like "-//W3C//DTD SVG 1.1//EN"); good to use in the onConfigLoad() function (New v7.9910)

•16 - limit messages to those having a category name that contains value anywhere in the name (case insensitive); can be called repeatedly to limit messages to multiple categories (New v8.9910)

•17 - add the value string to the list of recognized JavaScript content types; good to use in the onConfigLoad() function; does nothing in lite edition (New v9.0191)

•18 - add the value string to the list of recognized CSS content types; good to use in the onConfigLoad() function; does nothing in lite edition (New v9.0191)

•19 - append to the DOCTYPE tag name program to value; good to use in the onConfigLoad() function; also see 4 (New v9.0201)

•20 - set an extra set of comma-separated exclude words for the search engine keyword density message; good to use in the onConfigLoad() function (New v10.9912)

•21 - like 20, but appends instead (New v10.9915)

•22 - add the value string to the list of recognized doctypes that are case-insensitive; good to use in the onConfigLoad() function; example: setValueString(22,'!DOCTYPE html');; also see 3 (New v10.9925)

•In CSE HTML Validator v8.00 and later, can specify multiple value strings. This makes sense for some valueidentifiers but not all.

•This function is implemented only in CSE HTML Validator v4.05 and later.

setValueStringEx(int exp valueidentifier1,
 int exp valueidentifier2, int exp arg1,
 string exp value);

•valueidentifier1 - what string value to set

•1 - set an attribute value string

•valueidentifier2 - further specifies which string to set

•1 - the attribute value tag name program

•arg1 - the attribute value ID

•2 - append value to all validator messages having a specific message ID; before appending to a message, a space character is automatically appended first unless it's a blank message (new v7.9911)

•valueidentifier2 - should be 0

•arg1 - the message ID of the messages to append with the string value

•3 - set a flag description (New v9.9910)

•valueidentifier2 - the flag number to set the description for

•arg1 - not used, should be 0

•set value to "(not used)" to not display the flag in the Validator Engine Options

•value - the string value

•This function is implemented only in CSE HTML Validator v5.00 and later.

unDefine(string exp name1[, string exp name2...]);

•namex - the list of variable names to remove from memory

•After this function is used on a variable, such as name1, isDefined("name1") will again return 0. Accesses to the variable name will fail because it will no longer exist.

•If a variable name in the list is already undefined, then the function has no effect on the undefined variable name.

•Example: To remove a variable named var from memory, use unDefine("var"), do not use unDefine($var).