Gnome XSLT Library Reference Manual
<<< Previous Page | Home | Up | Next Page >>>

# variables

## Name

variables --

## Synopsis

    #define     XSLT_REGISTER_VARIABLE_LOOKUP   (ctxt)
    int         xsltEvalGlobalVariables         (xsltTransformContextPtr ctxt);
    int         xsltEvalUserParams              (xsltTransformContextPtr ctxt,
                                                 const char **params);
    int         xsltQuoteUserParams             (xsltTransformContextPtr ctxt,
                                                 const char **params);
    int         xsltEvalOneUserParam            (xsltTransformContextPtr ctxt,
                                                 const xmlChar *name,
                                                 const xmlChar *value);
    int         xsltQuoteOneUserParam           (xsltTransformContextPtr ctxt,
                                                 const xmlChar *name,
                                                 const xmlChar *value);
    void        xsltParseGlobalVariable         (xsltStylesheetPtr style,
                                                 xmlNodePtr cur);
    void        xsltParseGlobalParam            (xsltStylesheetPtr style,
                                                 xmlNodePtr cur);
    void        xsltParseStylesheetVariable     (xsltTransformContextPtr ctxt,
                                                 xmlNodePtr cur);
    void        xsltParseStylesheetParam        (xsltTransformContextPtr ctxt,
                                                 xmlNodePtr cur);
    xsltStackElemPtr xsltParseStylesheetCallerParam
                                                (xsltTransformContextPtr ctxt,
                                                 xmlNodePtr cur);
    int         xsltAddStackElemList            (xsltTransformContextPtr ctxt,
                                                 xsltStackElemPtr elems);
    void        xsltFreeGlobalVariables         (xsltTransformContextPtr ctxt);
    xmlXPathObjectPtr xsltVariableLookup        (xsltTransformContextPtr ctxt,
                                                 const xmlChar *name,
                                                 const xmlChar *ns_uri);
    xmlXPathObjectPtr xsltXPathVariableLookup   (void *ctxt,
                                                 const xmlChar *name,
                                                 const xmlChar *ns_uri);

## Description

## Details

### XSLT_REGISTER_VARIABLE_LOOKUP()

    #define     XSLT_REGISTER_VARIABLE_LOOKUP(ctxt)

Registering macro, not general purpose at all but used in different modules.

`ctxt` : |

### xsltEvalGlobalVariables ()

    int         xsltEvalGlobalVariables         (xsltTransformContextPtr ctxt);

Evaluate the global variables of a stylesheet. This need to be done on parsed stylesheets before starting to apply transformations

`ctxt` : | the XSLT transformation context
Returns : | 0 in case of success, -1 in case of error

### xsltEvalUserParams ()

    int         xsltEvalUserParams              (xsltTransformContextPtr ctxt,
                                                 const char **params);

`ctxt`: the XSLT transformation context `params`: a NULL terminated array of parameters name/value tuples

Evaluate the global variables of a stylesheet. This needs to be done on parsed stylesheets before starting to apply transformations. Each of the parameters is evaluated as an XPath expression and stored in the global variables/parameter hash table. If you want your parameter used literally, use xsltQuoteUserParams.

`ctxt` : |
`params` : |
Returns : | 0 in case of success, -1 in case of error

### xsltQuoteUserParams ()

    int         xsltQuoteUserParams             (xsltTransformContextPtr ctxt,
                                                 const char **params);

`ctxt`: the XSLT transformation context `params`: a NULL terminated arry of parameters names/values tuples

Similar to xsltEvalUserParams, but the values are treated literally and are * *not* evaluated as XPath expressions. This should be done on parsed stylesheets before starting to apply transformations.

`ctxt` : |
`params` : |
Returns : | 0 in case of success, -1 in case of error.

### xsltEvalOneUserParam ()

    int         xsltEvalOneUserParam            (xsltTransformContextPtr ctxt,
                                                 const xmlChar *name,
                                                 const xmlChar *value);

`ctxt`: the XSLT transformation context `name`: a null terminated string giving the name of the parameter `value` a null terminated string giving the XPath expression to be evaluated

This is normally called from xsltEvalUserParams to process a single parameter from a list of parameters. The `value` is evaluated as an XPath expression and the result is stored in the context's global variable/parameter hash table.

To have a parameter treated literally (not as an XPath expression) use xsltQuoteUserParams (or xsltQuoteOneUserParam). For more details see description of xsltProcessOneUserParamInternal.

`ctxt` : |
`name` : |
`value` : |
Returns : | 0 in case of success, -1 in case of error.

### xsltQuoteOneUserParam ()

    int         xsltQuoteOneUserParam           (xsltTransformContextPtr ctxt,
                                                 const xmlChar *name,
                                                 const xmlChar *value);

`ctxt`: the XSLT transformation context `name`: a null terminated string giving the name of the parameter `value` a null terminated string giving the parameter value

This is normally called from xsltQuoteUserParams to process a single parameter from a list of parameters. The `value` is stored in the context's global variable/parameter hash table.

`ctxt` : |
`name` : |
`value` : |
Returns : | 0 in case of success, -1 in case of error.

### xsltParseGlobalVariable ()

    void        xsltParseGlobalVariable         (xsltStylesheetPtr style,
                                                 xmlNodePtr cur);

parse an XSLT transformation variable declaration and record its value.

`style` : | the XSLT stylesheet
`cur` : | the "variable" element

### xsltParseGlobalParam ()

    void        xsltParseGlobalParam            (xsltStylesheetPtr style,
                                                 xmlNodePtr cur);

parse an XSLT transformation param declaration and record its value.

`style` : | the XSLT stylesheet
`cur` : | the "param" element

### xsltParseStylesheetVariable ()

    void        xsltParseStylesheetVariable     (xsltTransformContextPtr ctxt,
                                                 xmlNodePtr cur);

parse an XSLT transformation variable declaration and record its value.

`ctxt` : | the XSLT transformation context
`cur` : | the "variable" element

### xsltParseStylesheetParam ()

    void        xsltParseStylesheetParam        (xsltTransformContextPtr ctxt,
                                                 xmlNodePtr cur);

parse an XSLT transformation param declaration and record its value.

`ctxt` : | the XSLT transformation context
`cur` : | the "param" element

### xsltParseStylesheetCallerParam ()

    xsltStackElemPtr xsltParseStylesheetCallerParam
                                                (xsltTransformContextPtr ctxt,
                                                 xmlNodePtr cur);

parse an XSLT transformation param declaration, compute its value but doesn't record it.

It returns the new xsltStackElemPtr or NULL

`ctxt` : | the XSLT transformation context
`cur` : | the "param" element
Returns : |

### xsltAddStackElemList ()

    int         xsltAddStackElemList            (xsltTransformContextPtr ctxt,
                                                 xsltStackElemPtr elems);

add the new element list at this level of the stack.

`ctxt` : | xn XSLT transformation context
`elems` : | a stack element list
Returns : | 0 in case of success, -1 in case of failure.

### xsltFreeGlobalVariables ()

    void        xsltFreeGlobalVariables         (xsltTransformContextPtr ctxt);

Free up the data associated to the global variables its value.

`ctxt` : | the XSLT transformation context

### xsltVariableLookup ()

    xmlXPathObjectPtr xsltVariableLookup        (xsltTransformContextPtr ctxt,
                                                 const xmlChar *name,
                                                 const xmlChar *ns_uri);

Search in the Variable array of the context for the given variable value.

`ctxt` : | the XSLT transformation context
`name` : | the variable name
`ns_uri` : | the variable namespace URI
Returns : | the value or NULL if not found

### xsltXPathVariableLookup ()

    xmlXPathObjectPtr xsltXPathVariableLookup   (void *ctxt,
                                                 const xmlChar *name,
                                                 const xmlChar *ns_uri);

This is the entry point when a varibale is needed by the XPath interpretor.

`ctxt` : | a void * but the the XSLT transformation context actually
`name` : | the variable name
`ns_uri` : | the variable namespace URI
Returns : | the value or NULL if not found

<<< Previous Page | Home | Up | Next Page >>>
namespaces | keys