lr_xml_find

Verifies that XML values are returned by a query.

int lr_xml_find( <List of specifications> [, <List of optional specifications> ] [, LAST]);

The lr_xml_find function queries the XML input string XML for values matching the Query criteria (Value or ValueParam) and returns the number of occurrences. If SelectAll is "no", lr_xml_find returns either 1 or 0.

Return Values

See Return Values

Parameterization

See Parameterization

Example

The following example inserts an "extension" tag to an employee record. It first verifies, using lr_xml_find, that the record for the employee John Smith exists in the XML string xml_input. If it doesn't exist, then lr_xml_find will terminate execution of the script and send an error message.

However, if Continue on error is selected in the runtime settings or "NotFound =continue" is passed to lr_xml_find, the script will continue. In these cases, the check for the number of matches will prevent the lr_xml_insert from executing. For more options for handling error conditions, see lr_exit.

If the find operation succeeds, lr_xml_insert searches xml_input for the tag "<employee>" and inserts an XML fragment which contains the extension information. ("XmlFragment=<extension>2145</extension>").

The resulting string is contained in the ResultParam parameter, Result.

For more examples of the use of lr_xml_find, see Examples: common actions.

#include "as_web.h"

char *xml_input = 
"<acme_org>"
    "<employee level=\"manager\">John Smith"
        "<cubicle>227</cubicle>"
    "</employee>"
"</acme_org>";

Action() {
int find_cnt;

    lr_save_string(xml_input, "XML_Input_Param");

    /* Verify that employee John Smith exists */

    find_cnt = lr_xml_find("XML={XML_Input_Param}",

        "Value=John Smith", 

        "Query=/acme_org/employee", 

        LAST );

    if (find_cnt >0)

{

        /* Now insert John Smith's telephone extension number */

        lr_xml_insert("XML={XML_Input_Param}", "ResultParam=Result",

        "XmlFragment=<extension>2145</extension>", 

        "Query=/acme_org/employee",

        "Position=child", LAST );

        lr_output_message(lr_eval_string("String after insertion: {Result}"));

    } // end if find_cnt > 0 

return 0;
}

Example 2

The following example searches by the value of the level attribute. In the first instance, the text manager was found. In the second instance, no match was found for director.

    lr_xml_find(    "Xml={XML_Input_Param}",

         "Query=/acme_org/employee/@level",

        "Value=manager",

        LAST

    );

    lr_xml_find(    "Xml={XML_Input_Param}",

         "Query=/acme_org/employee/@level",

        "Value=director",

        LAST

    );