2020-02-17 21:17:06 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
< html > < head > < meta http-equiv = "Content-Type" content = "text/html;charset=iso-8859-1" >
< title > XQilla XQC API Documentation< / title >
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" >
< link href = "tabs.css" rel = "stylesheet" type = "text/css" >
< / head > < body >
< a style = "float:right;" href = "http://sourceforge.net/projects/xqilla" > < img src = "http://sflogo.sourceforge.net/sflogo.php?group_id=152021&type=2" border = "0" alt = "SourceForge.net Logo" / > < / a >
2020-02-17 21:19:08 +00:00
<!-- Generated by Doxygen 1.3.9.1 -->
< div class = "qindex" > < a class = "qindex" href = "index.html" > Main Page< / a > | < a class = "qindex" href = "annotated.html" > Class List< / a > | < a class = "qindex" href = "dirs.html" > Directories< / a > | < a class = "qindex" href = "files.html" > File List< / a > | < a class = "qindex" href = "functions.html" > Class Members< / a > | < a class = "qindex" href = "globals.html" > File Members< / a > | < a class = "qindex" href = "examples.html" > Examples< / a > < / div >
< h1 > XQC_Expression_s Struct Reference< / h1 > The < a class = "el" href = "xqc_8h.html#a3" > XQC_Expression< / a > struct represents a prepared query, and allows the user to execute that query any number of times.
2020-02-17 21:17:06 +00:00
< a href = "#_details" > More...< / a >
< p >
< code > #include < < a class = "el" href = "xqc_8h-source.html" > xqc.h< / a > > < / code >
< p >
< a href = "structXQC__Expression__s-members.html" > List of all members.< / a > < table border = "0" cellpadding = "0" cellspacing = "0" >
< tr > < td > < / td > < / tr >
< tr > < td colspan = "2" > < br > < h2 > Public Attributes< / h2 > < / td > < / tr >
2020-02-17 21:19:08 +00:00
< tr > < td class = "memItemLeft" nowrap align = "right" valign = "top" > < a class = "el" href = "xqc_8h.html#a66" > XQC_Error< / a > (* < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structXQC__Expression__s.html#o0" > create_context< / a > )(const < a class = "el" href = "structXQC__Expression__s.html" > XQC_Expression< / a > *expression, < a class = "el" href = "structXQC__DynamicContext__s.html" > XQC_DynamicContext< / a > **context)< / td > < / tr >
2020-02-17 21:17:06 +00:00
2020-02-17 21:19:08 +00:00
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Creates a dynamic context suitable for use in the < a class = "el" href = "structXQC__Expression__s.html#o1" > execute()< / a > function. < a href = "#o0" > < / a > < br > < / td > < / tr >
< tr > < td class = "memItemLeft" nowrap align = "right" valign = "top" > < a class = "el" href = "xqc_8h.html#a66" > XQC_Error< / a > (* < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structXQC__Expression__s.html#o1" > execute< / a > )(const < a class = "el" href = "structXQC__Expression__s.html" > XQC_Expression< / a > *expression, const < a class = "el" href = "structXQC__DynamicContext__s.html" > XQC_DynamicContext< / a > *context, < a class = "el" href = "structXQC__Sequence__s.html" > XQC_Sequence< / a > **sequence)< / td > < / tr >
2020-02-17 21:17:06 +00:00
2020-02-17 21:19:08 +00:00
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Executes the query represented by the XQC_Expression object using the values in the < a class = "el" href = "xqc_8h.html#a4" > XQC_DynamicContext< / a > if provided. < a href = "#o1" > < / a > < br > < / td > < / tr >
< tr > < td class = "memItemLeft" nowrap align = "right" valign = "top" > void *(* < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structXQC__Expression__s.html#o2" > get_interface< / a > )(const < a class = "el" href = "structXQC__Expression__s.html" > XQC_Expression< / a > *expression, const char *name)< / td > < / tr >
2020-02-17 21:17:06 +00:00
2020-02-17 21:19:08 +00:00
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Called to retrieve an implementation specific interface. < a href = "#o2" > < / a > < br > < / td > < / tr >
< tr > < td class = "memItemLeft" nowrap align = "right" valign = "top" > void(* < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structXQC__Expression__s.html#o3" > free< / a > )(< a class = "el" href = "structXQC__Expression__s.html" > XQC_Expression< / a > *expression)< / td > < / tr >
2020-02-17 21:17:06 +00:00
2020-02-17 21:19:08 +00:00
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Called to free the resources associated with the XQC_Expression. < a href = "#o3" > < / a > < br > < / td > < / tr >
2020-02-17 21:17:06 +00:00
< / table >
< hr > < a name = "_details" > < / a > < h2 > Detailed Description< / h2 >
2020-02-17 21:19:08 +00:00
The < a class = "el" href = "xqc_8h.html#a3" > XQC_Expression< / a > struct represents a prepared query, and allows the user to execute that query any number of times.
2020-02-17 21:17:06 +00:00
< p >
2020-02-17 21:19:08 +00:00
An < a class = "el" href = "xqc_8h.html#a3" > XQC_Expression< / a > object is thread-safe and can be used by multiple threads of execution at the same time.< p >
< a class = "el" href = "xqc_8h.html#a3" > XQC_Expression< / a > objects are created by calling the < a class = "el" href = "structXQC__Implementation__s.html#z0_1" > XQC_Implementation::prepare()< / a > , < a class = "el" href = "structXQC__Implementation__s.html#z0_2" > XQC_Implementation::prepare_file()< / a > and < a class = "el" href = "structXQC__Implementation__s.html#z0_3" > XQC_Implementation::prepare_stream()< / a > functions. Once created, the user is responsible for freeing the object by calling the < a class = "el" href = "structXQC__Expression__s.html#o3" > free()< / a > function. The < a class = "el" href = "xqc_8h.html#a3" > XQC_Expression< / a > object should be freed before the < a class = "el" href = "xqc_8h.html#a1" > XQC_Implementation< / a > object that created it.< dl compact > < dt > < b > Examples: < / b > < / dt > < dd >
2020-02-17 21:17:06 +00:00
< p >
2020-02-17 21:19:08 +00:00
< a class = "el" href = "xqc-basic_8c-example.html#_a1" > xqc-basic.c< / a > , and < a class = "el" href = "xqc-context-item_8c-example.html#_a12" > xqc-context-item.c< / a > .< / dl >
< p >
< hr > < h2 > Member Data Documentation< / h2 >
< a class = "anchor" name = "o0" doxytag = "XQC_Expression_s::create_context" > < / a > < p >
< table class = "mdTable" width = "100%" cellpadding = "2" cellspacing = "0" >
< tr >
< td class = "mdRow" >
< table cellpadding = "0" cellspacing = "0" border = "0" >
2020-02-17 21:17:06 +00:00
< tr >
2020-02-17 21:19:08 +00:00
< td class = "md" nowrap valign = "top" > < a class = "el" href = "xqc_8h.html#a66" > XQC_Error< / a > (* < a class = "el" href = "structXQC__Expression__s.html#o0" > XQC_Expression_s::create_context< / a > )(const < a class = "el" href = "structXQC__Expression__s.html" > XQC_Expression< / a > *expression, < a class = "el" href = "structXQC__DynamicContext__s.html" > XQC_DynamicContext< / a > **context) < / td >
2020-02-17 21:17:06 +00:00
< / tr >
< / table >
2020-02-17 21:19:08 +00:00
< / td >
< / tr >
< / table >
< table cellspacing = "5" cellpadding = "0" border = "0" >
< tr >
< td >
< / td >
< td >
2020-02-17 21:17:06 +00:00
< p >
2020-02-17 21:19:08 +00:00
Creates a dynamic context suitable for use in the < a class = "el" href = "structXQC__Expression__s.html#o1" > execute()< / a > function.
2020-02-17 21:17:06 +00:00
< p >
2020-02-17 21:19:08 +00:00
The user is responsible for freeing the < a class = "el" href = "xqc_8h.html#a4" > XQC_DynamicContext< / a > object returned by calling < a class = "el" href = "structXQC__DynamicContext__s.html#o9" > XQC_DynamicContext::free()< / a > .< p >
2020-02-17 21:17:06 +00:00
< dl compact > < dt > < b > Parameters:< / b > < / dt > < dd >
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > expression< / em > < / td > < td > The XQC_Expression that this function pointer is a member of. < / td > < / tr >
< tr > < td valign = "top" > < tt > [out]< / tt > < / td > < td valign = "top" > < em > context< / em > < / td > < td > The newly created XQC_DynamicContext object.< / td > < / tr >
< / table >
< / dl >
< dl compact > < dt > < b > Return values:< / b > < / dt > < dd >
< table border = "0" cellspacing = "2" cellpadding = "0" >
2020-02-17 21:19:08 +00:00
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > ::XQC_NO_ERROR< / em > < / td > < td > < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > ::XQC_INTERNAL_ERROR< / em > < / td > < td > < / td > < / tr >
2020-02-17 21:17:06 +00:00
< / table >
< / dl >
< dl compact > < dt > < b > Examples: < / b > < / dt > < dd >
2020-02-17 21:19:08 +00:00
< a class = "el" href = "xqc-context-item_8c-example.html#a18" > xqc-context-item.c< / a > .< / dl > < / td >
< / tr >
< / table >
< a class = "anchor" name = "o1" doxytag = "XQC_Expression_s::execute" > < / a > < p >
< table class = "mdTable" width = "100%" cellpadding = "2" cellspacing = "0" >
< tr >
< td class = "mdRow" >
< table cellpadding = "0" cellspacing = "0" border = "0" >
2020-02-17 21:17:06 +00:00
< tr >
2020-02-17 21:19:08 +00:00
< td class = "md" nowrap valign = "top" > < a class = "el" href = "xqc_8h.html#a66" > XQC_Error< / a > (* < a class = "el" href = "structXQC__Expression__s.html#o1" > XQC_Expression_s::execute< / a > )(const < a class = "el" href = "structXQC__Expression__s.html" > XQC_Expression< / a > *expression, const < a class = "el" href = "structXQC__DynamicContext__s.html" > XQC_DynamicContext< / a > *context, < a class = "el" href = "structXQC__Sequence__s.html" > XQC_Sequence< / a > **sequence) < / td >
2020-02-17 21:17:06 +00:00
< / tr >
< / table >
2020-02-17 21:19:08 +00:00
< / td >
< / tr >
< / table >
< table cellspacing = "5" cellpadding = "0" border = "0" >
< tr >
< td >
< / td >
< td >
2020-02-17 21:17:06 +00:00
< p >
2020-02-17 21:19:08 +00:00
Executes the query represented by the XQC_Expression object using the values in the < a class = "el" href = "xqc_8h.html#a4" > XQC_DynamicContext< / a > if provided.
2020-02-17 21:17:06 +00:00
< p >
2020-02-17 21:19:08 +00:00
An < a class = "el" href = "xqc_8h.html#a5" > XQC_Sequence< / a > object is returned which can be used to examine the results of the query execution. The user is responsible for freeing the < a class = "el" href = "xqc_8h.html#a5" > XQC_Sequence< / a > object returned by calling < a class = "el" href = "structXQC__Sequence__s.html#o2" > XQC_Sequence::free()< / a > .< p >
2020-02-17 21:17:06 +00:00
< dl compact > < dt > < b > Parameters:< / b > < / dt > < dd >
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > expression< / em > < / td > < td > The XQC_Expression that this function pointer is a member of. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > context< / em > < / td > < td > The dynamic context information to use when executing the query, or 0 to use the implementation defined default dynamic context. < / td > < / tr >
< tr > < td valign = "top" > < tt > [out]< / tt > < / td > < td valign = "top" > < em > sequence< / em > < / td > < td > The newly created XQC_Sequence object.< / td > < / tr >
< / table >
< / dl >
< dl compact > < dt > < b > Return values:< / b > < / dt > < dd >
< table border = "0" cellspacing = "2" cellpadding = "0" >
2020-02-17 21:19:08 +00:00
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > ::XQC_NO_ERROR< / em > < / td > < td > < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > ::XQC_INTERNAL_ERROR< / em > < / td > < td > < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > ::XQC_TYPE_ERROR< / em > < / td > < td > < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > ::XQC_DYNAMIC_ERROR< / em > < / td > < td > < / td > < / tr >
2020-02-17 21:17:06 +00:00
< / table >
< / dl >
< dl compact > < dt > < b > Examples: < / b > < / dt > < dd >
2020-02-17 21:19:08 +00:00
< a class = "el" href = "xqc-basic_8c-example.html#a5" > xqc-basic.c< / a > , and < a class = "el" href = "xqc-context-item_8c-example.html#a21" > xqc-context-item.c< / a > .< / dl > < / td >
< / tr >
< / table >
< a class = "anchor" name = "o3" doxytag = "XQC_Expression_s::free" > < / a > < p >
< table class = "mdTable" width = "100%" cellpadding = "2" cellspacing = "0" >
< tr >
< td class = "mdRow" >
< table cellpadding = "0" cellspacing = "0" border = "0" >
2020-02-17 21:17:06 +00:00
< tr >
2020-02-17 21:19:08 +00:00
< td class = "md" nowrap valign = "top" > void(* < a class = "el" href = "structXQC__Expression__s.html#o3" > XQC_Expression_s::free< / a > )(< a class = "el" href = "structXQC__Expression__s.html" > XQC_Expression< / a > *expression) < / td >
2020-02-17 21:17:06 +00:00
< / tr >
< / table >
2020-02-17 21:19:08 +00:00
< / td >
< / tr >
< / table >
< table cellspacing = "5" cellpadding = "0" border = "0" >
< tr >
< td >
< / td >
< td >
2020-02-17 21:17:06 +00:00
< p >
2020-02-17 21:19:08 +00:00
Called to free the resources associated with the XQC_Expression.
2020-02-17 21:17:06 +00:00
< p >
< dl compact > < dt > < b > Parameters:< / b > < / dt > < dd >
< table border = "0" cellspacing = "2" cellpadding = "0" >
2020-02-17 21:19:08 +00:00
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > expression< / em > < / td > < td > The XQC_Expression that this function pointer is a member of< / td > < / tr >
2020-02-17 21:17:06 +00:00
< / table >
< / dl >
2020-02-17 21:19:08 +00:00
< dl compact > < dt > < b > Examples: < / b > < / dt > < dd >
< a class = "el" href = "xqc-basic_8c-example.html#a9" > xqc-basic.c< / a > , and < a class = "el" href = "xqc-context-item_8c-example.html#a25" > xqc-context-item.c< / a > .< / dl > < / td >
< / tr >
< / table >
< a class = "anchor" name = "o2" doxytag = "XQC_Expression_s::get_interface" > < / a > < p >
< table class = "mdTable" width = "100%" cellpadding = "2" cellspacing = "0" >
< tr >
< td class = "mdRow" >
< table cellpadding = "0" cellspacing = "0" border = "0" >
2020-02-17 21:17:06 +00:00
< tr >
2020-02-17 21:19:08 +00:00
< td class = "md" nowrap valign = "top" > void*(* < a class = "el" href = "structXQC__Expression__s.html#o2" > XQC_Expression_s::get_interface< / a > )(const < a class = "el" href = "structXQC__Expression__s.html" > XQC_Expression< / a > *expression, const char *name) < / td >
2020-02-17 21:17:06 +00:00
< / tr >
< / table >
2020-02-17 21:19:08 +00:00
< / td >
< / tr >
< / table >
< table cellspacing = "5" cellpadding = "0" border = "0" >
< tr >
< td >
< / td >
< td >
2020-02-17 21:17:06 +00:00
< p >
2020-02-17 21:19:08 +00:00
Called to retrieve an implementation specific interface.
2020-02-17 21:17:06 +00:00
< p >
< dl compact > < dt > < b > Parameters:< / b > < / dt > < dd >
< table border = "0" cellspacing = "2" cellpadding = "0" >
2020-02-17 21:19:08 +00:00
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > expression< / em > < / td > < td > The XQC_Expression that this function pointer is a member of. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > name< / em > < / td > < td > The name that identifies the interface to return< / td > < / tr >
2020-02-17 21:17:06 +00:00
< / table >
< / dl >
2020-02-17 21:19:08 +00:00
< dl compact > < dt > < b > Returns:< / b > < / dt > < dd > A pointer to the interface, or 0 if the name is not recognized by this implementation of XQC.< / dd > < / dl >
< / td >
< / tr >
< / table >
2020-02-17 21:17:06 +00:00
< hr > The documentation for this struct was generated from the following file:< ul >
< li > < a class = "el" href = "xqc_8h-source.html" > xqc.h< / a > < / ul >
2020-02-17 21:19:08 +00:00
< hr size = "1" > < address style = "align: right;" > < small > Generated on Fri Sep 25 06:55:57 2009 for XQilla XQC API by
2020-02-17 21:17:06 +00:00
< a href = "http://www.doxygen.org/index.html" >
2020-02-17 21:19:08 +00:00
< img src = "doxygen.png" alt = "doxygen" align = "middle" border = "0" > < / a > 1.3.9.1 < / small > < / address >
2020-02-17 21:17:06 +00:00
< / body >
< / html >
