2020-02-17 22:17:06 +01: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 22:19:08 +01: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_Implementation_s Struct Reference< / h1 > The < a class = "el" href = "xqc_8h.html#a1" > XQC_Implementation< / a > struct provides factory functions for preparing queries.
2020-02-17 22:17:06 +01: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__Implementation__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 22:19:08 +01:00
< tr > < td class = "memItemLeft" nowrap align = "right" valign = "top" > void *(* < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structXQC__Implementation__s.html#o0" > get_interface< / a > )(const < a class = "el" href = "structXQC__Implementation__s.html" > XQC_Implementation< / a > *implementation, const char *name)< / td > < / tr >
2020-02-17 22:17:06 +01:00
2020-02-17 22:19:08 +01:00
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Called to retrieve an implementation specific interface. < a href = "#o0" > < / 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__Implementation__s.html#o1" > free< / a > )(< a class = "el" href = "structXQC__Implementation__s.html" > XQC_Implementation< / a > *implementation)< / td > < / tr >
2020-02-17 22:17:06 +01:00
2020-02-17 22:19:08 +01:00
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Called to free the resources associated with the XQC_Implementation. < a href = "#o1" > < / a > < br > < / td > < / tr >
2020-02-17 22:17:06 +01:00
< tr > < td colspan = "2" > < div class = "groupHeader" > Functions for preparing queries< / div > < / td > < / tr >
2020-02-17 22:19:08 +01: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__Implementation__s.html#z0_0" > create_context< / a > )(< a class = "el" href = "structXQC__Implementation__s.html" > XQC_Implementation< / a > *implementation, < a class = "el" href = "structXQC__StaticContext__s.html" > XQC_StaticContext< / a > **context)< / td > < / tr >
2020-02-17 22:17:06 +01:00
2020-02-17 22:19:08 +01:00
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Creates a static context suitable for use in the < a class = "el" href = "structXQC__Implementation__s.html#z0_1" > prepare()< / a > , < a class = "el" href = "structXQC__Implementation__s.html#z0_2" > prepare_file()< / a > and < a class = "el" href = "structXQC__Implementation__s.html#z0_3" > prepare_stream()< / a > functions. < a href = "#z0_0" > < / 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__Implementation__s.html#z0_1" > prepare< / a > )(< a class = "el" href = "structXQC__Implementation__s.html" > XQC_Implementation< / a > *implementation, const char *string, const < a class = "el" href = "structXQC__StaticContext__s.html" > XQC_StaticContext< / a > *context, < a class = "el" href = "structXQC__Expression__s.html" > XQC_Expression< / a > **expression)< / td > < / tr >
2020-02-17 22:17:06 +01:00
2020-02-17 22:19:08 +01:00
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Prepares a query from a UTF-8 string, returning an < a class = "el" href = "xqc_8h.html#a3" > XQC_Expression< / a > object. < a href = "#z0_1" > < / 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__Implementation__s.html#z0_2" > prepare_file< / a > )(< a class = "el" href = "structXQC__Implementation__s.html" > XQC_Implementation< / a > *implementation, FILE *file, const < a class = "el" href = "structXQC__StaticContext__s.html" > XQC_StaticContext< / a > *context, < a class = "el" href = "structXQC__Expression__s.html" > XQC_Expression< / a > **expression)< / td > < / tr >
2020-02-17 22:17:06 +01:00
2020-02-17 22:19:08 +01:00
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Prepares a query from a FILE pointer, returning an < a class = "el" href = "xqc_8h.html#a3" > XQC_Expression< / a > object. < a href = "#z0_2" > < / 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__Implementation__s.html#z0_3" > prepare_stream< / a > )(< a class = "el" href = "structXQC__Implementation__s.html" > XQC_Implementation< / a > *implementation, < a class = "el" href = "structXQC__InputStream__s.html" > XQC_InputStream< / a > *stream, const < a class = "el" href = "structXQC__StaticContext__s.html" > XQC_StaticContext< / a > *context, < a class = "el" href = "structXQC__Expression__s.html" > XQC_Expression< / a > **expression)< / td > < / tr >
2020-02-17 22:17:06 +01:00
2020-02-17 22:19:08 +01:00
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Prepares a query from an < a class = "el" href = "xqc_8h.html#a6" > XQC_InputStream< / a > , returning an < a class = "el" href = "xqc_8h.html#a3" > XQC_Expression< / a > object. < a href = "#z0_3" > < / a > < br > < / td > < / tr >
2020-02-17 22:17:06 +01:00
< tr > < td colspan = "2" > < div class = "groupHeader" > Functions for parsing documents< / div > < / td > < / tr >
2020-02-17 22:19:08 +01: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__Implementation__s.html#z1_0" > parse_document< / a > )(< a class = "el" href = "structXQC__Implementation__s.html" > XQC_Implementation< / a > *implementation, const char *string, < a class = "el" href = "structXQC__Sequence__s.html" > XQC_Sequence< / a > **sequence)< / td > < / tr >
2020-02-17 22:17:06 +01:00
2020-02-17 22:19:08 +01:00
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > XQC_PARSE_ERROR. < a href = "#z1_0" > < / 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__Implementation__s.html#z1_1" > parse_document_file< / a > )(< a class = "el" href = "structXQC__Implementation__s.html" > XQC_Implementation< / a > *implementation, FILE *file, < a class = "el" href = "structXQC__Sequence__s.html" > XQC_Sequence< / a > **sequence)< / td > < / tr >
2020-02-17 22:17:06 +01:00
2020-02-17 22:19:08 +01:00
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > XQC_PARSE_ERROR. < a href = "#z1_1" > < / 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__Implementation__s.html#z1_2" > parse_document_stream< / a > )(< a class = "el" href = "structXQC__Implementation__s.html" > XQC_Implementation< / a > *implementation, < a class = "el" href = "structXQC__InputStream__s.html" > XQC_InputStream< / a > *stream, < a class = "el" href = "structXQC__Sequence__s.html" > XQC_Sequence< / a > **sequence)< / td > < / tr >
2020-02-17 22:17:06 +01:00
2020-02-17 22:19:08 +01:00
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > XQC_PARSE_ERROR. < a href = "#z1_2" > < / a > < br > < / td > < / tr >
2020-02-17 22:17:06 +01:00
< tr > < td colspan = "2" > < div class = "groupHeader" > Functions for creating sequences< / div > < / td > < / tr >
2020-02-17 22:19:08 +01: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__Implementation__s.html#z2_0" > create_empty_sequence< / a > )(< a class = "el" href = "structXQC__Implementation__s.html" > XQC_Implementation< / a > *implementation, < a class = "el" href = "structXQC__Sequence__s.html" > XQC_Sequence< / a > **sequence)< / td > < / tr >
2020-02-17 22:17:06 +01:00
2020-02-17 22:19:08 +01: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__Implementation__s.html#z2_1" > create_singleton_sequence< / a > )(< a class = "el" href = "structXQC__Implementation__s.html" > XQC_Implementation< / a > *implementation, < a class = "el" href = "xqc_8h.html#a67" > XQC_ItemType< / a > type, const char *value, < a class = "el" href = "structXQC__Sequence__s.html" > XQC_Sequence< / a > **sequence)< / td > < / tr >
2020-02-17 22:17:06 +01:00
2020-02-17 22:19:08 +01: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__Implementation__s.html#z2_2" > create_string_sequence< / a > )(< a class = "el" href = "structXQC__Implementation__s.html" > XQC_Implementation< / a > *implementation, const char *values[], unsigned int count, < a class = "el" href = "structXQC__Sequence__s.html" > XQC_Sequence< / a > **sequence)< / td > < / tr >
2020-02-17 22:17:06 +01:00
2020-02-17 22:19:08 +01: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__Implementation__s.html#z2_3" > create_integer_sequence< / a > )(< a class = "el" href = "structXQC__Implementation__s.html" > XQC_Implementation< / a > *implementation, int values[], unsigned int count, < a class = "el" href = "structXQC__Sequence__s.html" > XQC_Sequence< / a > **sequence)< / td > < / tr >
2020-02-17 22:17:06 +01:00
2020-02-17 22:19:08 +01: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__Implementation__s.html#z2_4" > create_double_sequence< / a > )(< a class = "el" href = "structXQC__Implementation__s.html" > XQC_Implementation< / a > *implementation, double values[], unsigned int count, < a class = "el" href = "structXQC__Sequence__s.html" > XQC_Sequence< / a > **sequence)< / td > < / tr >
2020-02-17 22:17:06 +01:00
< / table >
< hr > < a name = "_details" > < / a > < h2 > Detailed Description< / h2 >
2020-02-17 22:19:08 +01:00
The < a class = "el" href = "xqc_8h.html#a1" > XQC_Implementation< / a > struct provides factory functions for preparing queries.
2020-02-17 22:17:06 +01:00
< p >
An XQC_Implementation object is thread-safe and can be used by multiple threads of execution at the same time.< p >
2020-02-17 22:19:08 +01:00
The method of creating an XQC_Implementation object is beyond the scope of this API, and will typically involve calling an implementation defined function. Once created, the user is responsible for freeing the object by calling the < a class = "el" href = "structXQC__Implementation__s.html#o1" > free()< / a > function. The XQC_Implementation object should not be freed before all objects created using it's functions have been freed - doing so may cause undefined behaviour. < dl compact > < dt > < b > Examples: < / b > < / dt > < dd >
2020-02-17 22:17:06 +01:00
< p >
2020-02-17 22:19:08 +01:00
< a class = "el" href = "xqc-basic_8c-example.html#_a0" > xqc-basic.c< / a > , and < a class = "el" href = "xqc-context-item_8c-example.html#_a11" > xqc-context-item.c< / a > .< / dl >
< p >
< hr > < h2 > Member Data Documentation< / h2 >
< a class = "anchor" name = "z0_0" doxytag = "XQC_Implementation_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 22:17:06 +01:00
< tr >
2020-02-17 22:19:08 +01:00
< td class = "md" nowrap valign = "top" > < a class = "el" href = "xqc_8h.html#a66" > XQC_Error< / a > (* < a class = "el" href = "structXQC__Implementation__s.html#z0_0" > XQC_Implementation_s::create_context< / a > )(< a class = "el" href = "structXQC__Implementation__s.html" > XQC_Implementation< / a > *implementation, < a class = "el" href = "structXQC__StaticContext__s.html" > XQC_StaticContext< / a > **context) < / td >
2020-02-17 22:17:06 +01:00
< / tr >
< / table >
2020-02-17 22:19:08 +01:00
< / td >
< / tr >
< / table >
< table cellspacing = "5" cellpadding = "0" border = "0" >
< tr >
< td >
< / td >
< td >
2020-02-17 22:17:06 +01:00
< p >
2020-02-17 22:19:08 +01:00
Creates a static context suitable for use in the < a class = "el" href = "structXQC__Implementation__s.html#z0_1" > prepare()< / a > , < a class = "el" href = "structXQC__Implementation__s.html#z0_2" > prepare_file()< / a > and < a class = "el" href = "structXQC__Implementation__s.html#z0_3" > prepare_stream()< / a > functions.
2020-02-17 22:17:06 +01:00
< p >
2020-02-17 22:19:08 +01:00
The user is responsible for freeing the < a class = "el" href = "xqc_8h.html#a2" > XQC_StaticContext< / a > object returned by calling < a class = "el" href = "structXQC__StaticContext__s.html#o24" > XQC_StaticContext::free()< / a > .< p >
2020-02-17 22:17:06 +01: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 > implementation< / em > < / td > < td > The XQC_Implementation 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_StaticContext object.< / td > < / tr >
< / table >
< / dl >
< dl compact > < dt > < b > Return values:< / b > < / dt > < dd >
< table border = "0" cellspacing = "2" cellpadding = "0" >
2020-02-17 22:19:08 +01: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 22:17:06 +01:00
< / table >
< / dl >
2020-02-17 22:19:08 +01:00
< / td >
< / tr >
< / table >
< a class = "anchor" name = "z2_4" doxytag = "XQC_Implementation_s::create_double_sequence" > < / 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 22:17:06 +01:00
< tr >
2020-02-17 22:19:08 +01:00
< td class = "md" nowrap valign = "top" > < a class = "el" href = "xqc_8h.html#a66" > XQC_Error< / a > (* < a class = "el" href = "structXQC__Implementation__s.html#z2_4" > XQC_Implementation_s::create_double_sequence< / a > )(< a class = "el" href = "structXQC__Implementation__s.html" > XQC_Implementation< / a > *implementation, double values[], unsigned int count, < a class = "el" href = "structXQC__Sequence__s.html" > XQC_Sequence< / a > **sequence) < / td >
2020-02-17 22:17:06 +01:00
< / tr >
< / table >
2020-02-17 22:19:08 +01:00
< / td >
< / tr >
< / table >
< table cellspacing = "5" cellpadding = "0" border = "0" >
< tr >
< td >
< / td >
< td >
2020-02-17 22:17:06 +01:00
< p >
2020-02-17 22:19:08 +01:00
< / td >
< / tr >
< / table >
< a class = "anchor" name = "z2_0" doxytag = "XQC_Implementation_s::create_empty_sequence" > < / 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 22:17:06 +01:00
< tr >
2020-02-17 22:19:08 +01:00
< td class = "md" nowrap valign = "top" > < a class = "el" href = "xqc_8h.html#a66" > XQC_Error< / a > (* < a class = "el" href = "structXQC__Implementation__s.html#z2_0" > XQC_Implementation_s::create_empty_sequence< / a > )(< a class = "el" href = "structXQC__Implementation__s.html" > XQC_Implementation< / a > *implementation, < a class = "el" href = "structXQC__Sequence__s.html" > XQC_Sequence< / a > **sequence) < / td >
2020-02-17 22:17:06 +01:00
< / tr >
< / table >
2020-02-17 22:19:08 +01:00
< / td >
< / tr >
< / table >
< table cellspacing = "5" cellpadding = "0" border = "0" >
< tr >
< td >
< / td >
< td >
2020-02-17 22:17:06 +01:00
< p >
2020-02-17 22:19:08 +01:00
< / td >
< / tr >
< / table >
< a class = "anchor" name = "z2_3" doxytag = "XQC_Implementation_s::create_integer_sequence" > < / 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 22:17:06 +01:00
< tr >
2020-02-17 22:19:08 +01:00
< td class = "md" nowrap valign = "top" > < a class = "el" href = "xqc_8h.html#a66" > XQC_Error< / a > (* < a class = "el" href = "structXQC__Implementation__s.html#z2_3" > XQC_Implementation_s::create_integer_sequence< / a > )(< a class = "el" href = "structXQC__Implementation__s.html" > XQC_Implementation< / a > *implementation, int values[], unsigned int count, < a class = "el" href = "structXQC__Sequence__s.html" > XQC_Sequence< / a > **sequence) < / td >
2020-02-17 22:17:06 +01:00
< / tr >
< / table >
2020-02-17 22:19:08 +01:00
< / td >
< / tr >
< / table >
< table cellspacing = "5" cellpadding = "0" border = "0" >
< tr >
< td >
< / td >
< td >
2020-02-17 22:17:06 +01:00
< p >
2020-02-17 22:19:08 +01:00
< / td >
< / tr >
< / table >
< a class = "anchor" name = "z2_1" doxytag = "XQC_Implementation_s::create_singleton_sequence" > < / 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 22:17:06 +01:00
< tr >
2020-02-17 22:19:08 +01:00
< td class = "md" nowrap valign = "top" > < a class = "el" href = "xqc_8h.html#a66" > XQC_Error< / a > (* < a class = "el" href = "structXQC__Implementation__s.html#z2_1" > XQC_Implementation_s::create_singleton_sequence< / a > )(< a class = "el" href = "structXQC__Implementation__s.html" > XQC_Implementation< / a > *implementation, < a class = "el" href = "xqc_8h.html#a67" > XQC_ItemType< / a > type, const char *value, < a class = "el" href = "structXQC__Sequence__s.html" > XQC_Sequence< / a > **sequence) < / td >
2020-02-17 22:17:06 +01:00
< / tr >
< / table >
2020-02-17 22:19:08 +01:00
< / td >
< / tr >
< / table >
< table cellspacing = "5" cellpadding = "0" border = "0" >
< tr >
< td >
< / td >
< td >
2020-02-17 22:17:06 +01:00
< p >
2020-02-17 22:19:08 +01:00
< / td >
< / tr >
< / table >
< a class = "anchor" name = "z2_2" doxytag = "XQC_Implementation_s::create_string_sequence" > < / 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 22:17:06 +01:00
< tr >
2020-02-17 22:19:08 +01:00
< td class = "md" nowrap valign = "top" > < a class = "el" href = "xqc_8h.html#a66" > XQC_Error< / a > (* < a class = "el" href = "structXQC__Implementation__s.html#z2_2" > XQC_Implementation_s::create_string_sequence< / a > )(< a class = "el" href = "structXQC__Implementation__s.html" > XQC_Implementation< / a > *implementation, const char *values[], unsigned int count, < a class = "el" href = "structXQC__Sequence__s.html" > XQC_Sequence< / a > **sequence) < / td >
2020-02-17 22:17:06 +01:00
< / tr >
< / table >
2020-02-17 22:19:08 +01:00
< / td >
< / tr >
< / table >
< table cellspacing = "5" cellpadding = "0" border = "0" >
< tr >
< td >
< / td >
< td >
2020-02-17 22:17:06 +01:00
< p >
2020-02-17 22:19:08 +01:00
< / td >
< / tr >
< / table >
< a class = "anchor" name = "o1" doxytag = "XQC_Implementation_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 22:17:06 +01:00
< tr >
2020-02-17 22:19:08 +01:00
< td class = "md" nowrap valign = "top" > void(* < a class = "el" href = "structXQC__Implementation__s.html#o1" > XQC_Implementation_s::free< / a > )(< a class = "el" href = "structXQC__Implementation__s.html" > XQC_Implementation< / a > *implementation) < / td >
2020-02-17 22:17:06 +01:00
< / tr >
< / table >
2020-02-17 22:19:08 +01:00
< / td >
< / tr >
< / table >
< table cellspacing = "5" cellpadding = "0" border = "0" >
< tr >
< td >
< / td >
< td >
2020-02-17 22:17:06 +01:00
< p >
2020-02-17 22:19:08 +01:00
Called to free the resources associated with the XQC_Implementation.
2020-02-17 22:17:06 +01:00
< p >
2020-02-17 22:19:08 +01: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 > implementation< / em > < / td > < td > The XQC_Implementation that this function pointer is a member of< / td > < / tr >
< / table >
< / dl >
< dl compact > < dt > < b > Examples: < / b > < / dt > < dd >
< a class = "el" href = "xqc-basic_8c-example.html#a10" > xqc-basic.c< / a > , and < a class = "el" href = "xqc-context-item_8c-example.html#a26" > xqc-context-item.c< / a > .< / dl > < / td >
< / tr >
< / table >
< a class = "anchor" name = "o0" doxytag = "XQC_Implementation_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 22:17:06 +01:00
< tr >
2020-02-17 22:19:08 +01:00
< td class = "md" nowrap valign = "top" > void*(* < a class = "el" href = "structXQC__Implementation__s.html#o0" > XQC_Implementation_s::get_interface< / a > )(const < a class = "el" href = "structXQC__Implementation__s.html" > XQC_Implementation< / a > *implementation, const char *name) < / td >
2020-02-17 22:17:06 +01:00
< / tr >
< / table >
2020-02-17 22:19:08 +01:00
< / td >
< / tr >
< / table >
< table cellspacing = "5" cellpadding = "0" border = "0" >
< tr >
< td >
< / td >
< td >
2020-02-17 22:17:06 +01:00
< p >
2020-02-17 22:19:08 +01:00
Called to retrieve an implementation specific interface.
< p >
< dl compact > < dt > < b > Parameters:< / b > < / dt > < dd >
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > implementation< / em > < / td > < td > The XQC_Implementation 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 >
< / table >
< / dl >
< 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 >
< a class = "anchor" name = "z1_0" doxytag = "XQC_Implementation_s::parse_document" > < / 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 22:17:06 +01:00
< tr >
2020-02-17 22:19:08 +01:00
< td class = "md" nowrap valign = "top" > < a class = "el" href = "xqc_8h.html#a66" > XQC_Error< / a > (* < a class = "el" href = "structXQC__Implementation__s.html#z1_0" > XQC_Implementation_s::parse_document< / a > )(< a class = "el" href = "structXQC__Implementation__s.html" > XQC_Implementation< / a > *implementation, const char *string, < a class = "el" href = "structXQC__Sequence__s.html" > XQC_Sequence< / a > **sequence) < / td >
2020-02-17 22:17:06 +01:00
< / tr >
< / table >
2020-02-17 22:19:08 +01:00
< / td >
< / tr >
< / table >
< table cellspacing = "5" cellpadding = "0" border = "0" >
< tr >
< td >
< / td >
< td >
2020-02-17 22:17:06 +01:00
< p >
2020-02-17 22:19:08 +01:00
XQC_PARSE_ERROR.
< p >
< dl compact > < dt > < b > Examples: < / b > < / dt > < dd >
< a class = "el" href = "xqc-context-item_8c-example.html#a17" > xqc-context-item.c< / a > .< / dl > < / td >
< / tr >
< / table >
< a class = "anchor" name = "z1_1" doxytag = "XQC_Implementation_s::parse_document_file" > < / 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 22:17:06 +01:00
< tr >
2020-02-17 22:19:08 +01:00
< td class = "md" nowrap valign = "top" > < a class = "el" href = "xqc_8h.html#a66" > XQC_Error< / a > (* < a class = "el" href = "structXQC__Implementation__s.html#z1_1" > XQC_Implementation_s::parse_document_file< / a > )(< a class = "el" href = "structXQC__Implementation__s.html" > XQC_Implementation< / a > *implementation, FILE *file, < a class = "el" href = "structXQC__Sequence__s.html" > XQC_Sequence< / a > **sequence) < / td >
2020-02-17 22:17:06 +01:00
< / tr >
< / table >
2020-02-17 22:19:08 +01:00
< / td >
< / tr >
< / table >
< table cellspacing = "5" cellpadding = "0" border = "0" >
< tr >
< td >
< / td >
< td >
2020-02-17 22:17:06 +01:00
< p >
2020-02-17 22:19:08 +01:00
XQC_PARSE_ERROR.
< p >
< / td >
< / tr >
< / table >
< a class = "anchor" name = "z1_2" doxytag = "XQC_Implementation_s::parse_document_stream" > < / 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 22:17:06 +01:00
< tr >
2020-02-17 22:19:08 +01:00
< td class = "md" nowrap valign = "top" > < a class = "el" href = "xqc_8h.html#a66" > XQC_Error< / a > (* < a class = "el" href = "structXQC__Implementation__s.html#z1_2" > XQC_Implementation_s::parse_document_stream< / a > )(< a class = "el" href = "structXQC__Implementation__s.html" > XQC_Implementation< / a > *implementation, < a class = "el" href = "structXQC__InputStream__s.html" > XQC_InputStream< / a > *stream, < a class = "el" href = "structXQC__Sequence__s.html" > XQC_Sequence< / a > **sequence) < / td >
2020-02-17 22:17:06 +01:00
< / tr >
< / table >
2020-02-17 22:19:08 +01:00
< / td >
< / tr >
< / table >
< table cellspacing = "5" cellpadding = "0" border = "0" >
< tr >
< td >
< / td >
< td >
2020-02-17 22:17:06 +01:00
< p >
2020-02-17 22:19:08 +01:00
XQC_PARSE_ERROR.
< p >
< / td >
< / tr >
< / table >
< a class = "anchor" name = "z0_1" doxytag = "XQC_Implementation_s::prepare" > < / 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 22:17:06 +01:00
< tr >
2020-02-17 22:19:08 +01:00
< td class = "md" nowrap valign = "top" > < a class = "el" href = "xqc_8h.html#a66" > XQC_Error< / a > (* < a class = "el" href = "structXQC__Implementation__s.html#z0_1" > XQC_Implementation_s::prepare< / a > )(< a class = "el" href = "structXQC__Implementation__s.html" > XQC_Implementation< / a > *implementation, const char *string, const < a class = "el" href = "structXQC__StaticContext__s.html" > XQC_StaticContext< / a > *context, < a class = "el" href = "structXQC__Expression__s.html" > XQC_Expression< / a > **expression) < / td >
2020-02-17 22:17:06 +01:00
< / tr >
< / table >
2020-02-17 22:19:08 +01:00
< / td >
< / tr >
< / table >
< table cellspacing = "5" cellpadding = "0" border = "0" >
< tr >
< td >
< / td >
< td >
2020-02-17 22:17:06 +01:00
< p >
2020-02-17 22:19:08 +01:00
Prepares a query from a UTF-8 string, returning an < a class = "el" href = "xqc_8h.html#a3" > XQC_Expression< / a > object.
< p >
The user remains responsible for closing the file after preparation. The user is responsible for freeing the < a class = "el" href = "xqc_8h.html#a3" > XQC_Expression< / a > object returned by calling < a class = "el" href = "structXQC__Expression__s.html#o3" > XQC_Expression::free()< / a > .< p >
< dl compact > < dt > < b > Parameters:< / b > < / dt > < dd >
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > implementation< / em > < / td > < td > The XQC_Implementation that this function pointer is a member of. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > string< / em > < / td > < td > The query to prepare as a UTF-8 string. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > context< / em > < / td > < td > The initial static context for this query, or 0 to use the implementation defined default static context. < / td > < / tr >
< tr > < td valign = "top" > < tt > [out]< / tt > < / td > < td valign = "top" > < em > expression< / em > < / td > < td > The resulting prepared expression.< / td > < / tr >
< / table >
< / dl >
< dl compact > < dt > < b > Return values:< / b > < / dt > < dd >
< table border = "0" cellspacing = "2" cellpadding = "0" >
< 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_STATIC_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 >
< / table >
< / dl >
< dl compact > < dt > < b > Examples: < / b > < / dt > < dd >
< a class = "el" href = "xqc-basic_8c-example.html#a4" > xqc-basic.c< / a > , and < a class = "el" href = "xqc-context-item_8c-example.html#a16" > xqc-context-item.c< / a > .< / dl > < / td >
< / tr >
< / table >
< a class = "anchor" name = "z0_2" doxytag = "XQC_Implementation_s::prepare_file" > < / 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 22:17:06 +01:00
< tr >
2020-02-17 22:19:08 +01:00
< td class = "md" nowrap valign = "top" > < a class = "el" href = "xqc_8h.html#a66" > XQC_Error< / a > (* < a class = "el" href = "structXQC__Implementation__s.html#z0_2" > XQC_Implementation_s::prepare_file< / a > )(< a class = "el" href = "structXQC__Implementation__s.html" > XQC_Implementation< / a > *implementation, FILE *file, const < a class = "el" href = "structXQC__StaticContext__s.html" > XQC_StaticContext< / a > *context, < a class = "el" href = "structXQC__Expression__s.html" > XQC_Expression< / a > **expression) < / td >
2020-02-17 22:17:06 +01:00
< / tr >
< / table >
2020-02-17 22:19:08 +01:00
< / td >
< / tr >
< / table >
< table cellspacing = "5" cellpadding = "0" border = "0" >
< tr >
< td >
< / td >
< td >
2020-02-17 22:17:06 +01:00
< p >
2020-02-17 22:19:08 +01:00
Prepares a query from a FILE pointer, returning an < a class = "el" href = "xqc_8h.html#a3" > XQC_Expression< / a > object.
2020-02-17 22:17:06 +01:00
< p >
2020-02-17 22:19:08 +01:00
The encoding of the query in the file is determined by the implementation. The user remains responsible for closing the file after preparation. The user is responsible for freeing the < a class = "el" href = "xqc_8h.html#a3" > XQC_Expression< / a > object returned by calling < a class = "el" href = "structXQC__Expression__s.html#o3" > XQC_Expression::free()< / a > .< p >
2020-02-17 22:17:06 +01:00
< dl compact > < dt > < b > Parameters:< / b > < / dt > < dd >
< table border = "0" cellspacing = "2" cellpadding = "0" >
2020-02-17 22:19:08 +01:00
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > implementation< / em > < / td > < td > The XQC_Implementation that this function pointer is a member of. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > file< / em > < / td > < td > The file containing the query to prepare. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > context< / em > < / td > < td > The initial static context for this query, or 0 to use the implementation defined default static context. < / td > < / tr >
< tr > < td valign = "top" > < tt > [out]< / tt > < / td > < td valign = "top" > < em > expression< / em > < / td > < td > The resulting prepared expression.< / td > < / tr >
2020-02-17 22:17:06 +01:00
< / table >
< / dl >
2020-02-17 22:19:08 +01:00
< dl compact > < dt > < b > Return values:< / b > < / dt > < dd >
< table border = "0" cellspacing = "2" cellpadding = "0" >
< 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_UNRECOGNIZED_ENCODING< / em > < / td > < td > < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > ::XQC_STATIC_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 >
< / table >
< / dl >
< / td >
< / tr >
< / table >
< a class = "anchor" name = "z0_3" doxytag = "XQC_Implementation_s::prepare_stream" > < / 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 22:17:06 +01:00
< tr >
2020-02-17 22:19:08 +01:00
< td class = "md" nowrap valign = "top" > < a class = "el" href = "xqc_8h.html#a66" > XQC_Error< / a > (* < a class = "el" href = "structXQC__Implementation__s.html#z0_3" > XQC_Implementation_s::prepare_stream< / a > )(< a class = "el" href = "structXQC__Implementation__s.html" > XQC_Implementation< / a > *implementation, < a class = "el" href = "structXQC__InputStream__s.html" > XQC_InputStream< / a > *stream, const < a class = "el" href = "structXQC__StaticContext__s.html" > XQC_StaticContext< / a > *context, < a class = "el" href = "structXQC__Expression__s.html" > XQC_Expression< / a > **expression) < / td >
2020-02-17 22:17:06 +01:00
< / tr >
< / table >
2020-02-17 22:19:08 +01:00
< / td >
< / tr >
< / table >
< table cellspacing = "5" cellpadding = "0" border = "0" >
< tr >
< td >
< / td >
< td >
2020-02-17 22:17:06 +01:00
< p >
2020-02-17 22:19:08 +01:00
Prepares a query from an < a class = "el" href = "xqc_8h.html#a6" > XQC_InputStream< / a > , returning an < a class = "el" href = "xqc_8h.html#a3" > XQC_Expression< / a > object.
2020-02-17 22:17:06 +01:00
< p >
2020-02-17 22:19:08 +01:00
The encoding of the stream is determined by looking at < a class = "el" href = "structXQC__InputStream__s.html#o0" > XQC_InputStream::encoding< / a > , or by the implementation if < a class = "el" href = "structXQC__InputStream__s.html#o0" > XQC_InputStream::encoding< / a > is 0. The implementation is responsible for freeing the < a class = "el" href = "xqc_8h.html#a6" > XQC_InputStream< / a > using the < a class = "el" href = "structXQC__InputStream__s.html#o3" > XQC_InputStream::free()< / a > function after it has finished with using it. The user is responsible for freeing the < a class = "el" href = "xqc_8h.html#a3" > XQC_Expression< / a > object returned by calling < a class = "el" href = "structXQC__Expression__s.html#o3" > XQC_Expression::free()< / a > .< p >
2020-02-17 22:17:06 +01: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 > implementation< / em > < / td > < td > The XQC_Implementation that this function pointer is a member of < / td > < / tr >
2020-02-17 22:19:08 +01:00
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > stream< / em > < / td > < td > The stream returning the query to prepare. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > context< / em > < / td > < td > The initial static context for this query, or 0 to use the implementation defined default static context. < / td > < / tr >
< tr > < td valign = "top" > < tt > [out]< / tt > < / td > < td valign = "top" > < em > expression< / em > < / td > < td > The resulting prepared expression< / td > < / tr >
2020-02-17 22:17:06 +01:00
< / table >
< / dl >
2020-02-17 22:19:08 +01:00
< dl compact > < dt > < b > Return values:< / b > < / dt > < dd >
< table border = "0" cellspacing = "2" cellpadding = "0" >
< 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_UNRECOGNIZED_ENCODING< / em > < / td > < td > < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > ::XQC_STATIC_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 >
< / table >
< / dl >
< / td >
< / tr >
< / table >
2020-02-17 22:17:06 +01: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 22:19:08 +01: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 22:17:06 +01:00
< a href = "http://www.doxygen.org/index.html" >
2020-02-17 22:19:08 +01:00
< img src = "doxygen.png" alt = "doxygen" align = "middle" border = "0" > < / a > 1.3.9.1 < / small > < / address >
2020-02-17 22:17:06 +01:00
< / body >
< / html >
