#include <zorba/zorbac.h>
Data Fields |
XQC_Error(* | add_collation )(Zorba_StaticContext *context, const char *uri) |
| Add a collation URI.
|
XQC_Error(* | get_default_collation )(Zorba_StaticContext *context, const char **uri) |
| Get the URI of the default collation.
|
XQC_Error(* | get_xquery_version )(Zorba_StaticContext *context, XQC_XQueryVersion *ver) |
| Returns the XQuery processor's version that is set in the given static context.
|
XQC_Error(* | register_external_function )(Zorba_StaticContext *context, const char *uri, const char *localname, external_function_init init_fn, external_function_next next_fn, external_function_free free_fn, void *global_user_data) |
| Register an external function that can be called within a query.
|
XQC_Error(* | set_default_collation )(Zorba_StaticContext *context, const char *uri) |
| Set the URI of the default collation.
|
XQC_Error(* | set_xquery_version )(Zorba_StaticContext *context, XQC_XQueryVersion ver) |
| Sets the XQuery processor's version to either xquery_version_1_0 or xquery_version_3_0.
|
Field Documentation
Get the URI of the default collation.
The uri returned is valid as long as the corresponding XQC_StaticContext object is valid.
- Parameters:
-
| context | The XQC_StaticContext that this function pointer is a member of |
[out] | uri | The URI of the default collation that is currently set in the given context. |
Definition at line 115 of file zorbac.h.
Returns the XQuery processor's version that is set in the given static context.
- Parameters:
-
| context | The XQC_StaticContext that this function pointer is a member of |
[out] | mode | The xquery_version_t that is set in the given context. |
- Return values:
-
::XQC_NO_ERROR | |
::XQC_INTERNAL_ERROR | |
Definition at line 140 of file zorbac.h.
Register an external function that can be called within a query.
One external function consists of three function parameters, i.e. init, next, and release.
- Parameters:
-
context | The XQC_StaticContext that this function pointer is a member of |
uri | The URI of the external function to add. |
localname | The localname of the function to add. |
init | A callback function pointer that is called once when the external function is initialized. The init function gets the global_user_data pointer as parameter. |
release | A callback function pointer that is called once when the external function is deinitialized. |
global_user_data | User specific data that is passed to the init function as a parameter. |
- Return values:
-
::XQC_NO_ERROR | |
::ZAPI0019_FUNCTION_ALREADY_REGISTERED,\retval | ::XQC_INTERNAL_ERROR |
Definition at line 161 of file zorbac.h.
Set the URI of the default collation.
(see http://www.w3.org/TR/xquery/#static_context)
- Parameters:
-
context | The XQC_StaticContext that this function pointer is a member of |
uri | The URI of the default collation to set |
- Return values:
-
::XQC_NO_ERROR | |
::XQST0038 | |
::XQC_INTERNAL_ERROR | |
Definition at line 105 of file zorbac.h.
Sets the XQuery processor's version to either xquery_version_1_0 or xquery_version_3_0.
- Parameters:
-
context | The XQC_StaticContext that this function pointer is a member of |
mode | The xquery_version_t to set in the given context. |
- Return values:
-
::XQC_NO_ERROR | |
::XQC_INTERNAL_ERROR | |
Definition at line 128 of file zorbac.h.
The documentation for this struct was generated from the following file: