\hypertarget{group__misc__functions}{}\doxysection{Miscellaneous Functions} \label{group__misc__functions}\index{Miscellaneous Functions@{Miscellaneous Functions}} Collaboration diagram for Miscellaneous Functions\+: % FIG 0 \doxysubsection*{Modules} \begin{DoxyCompactItemize} \item \mbox{\hyperlink{group__parse__url__options}{URL Parsing Options}} \item \mbox{\hyperlink{group___string_concat_encoding}{String Concatenation Encoding Codes}} \item \mbox{\hyperlink{group___string_concat_decoding}{String Concatenation Decoding Codes}} \item \mbox{\hyperlink{group__signal__constants}{Signal Constants}} \end{DoxyCompactItemize} \doxysubsection*{Functions} \begin{DoxyCompactItemize} \item \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{group__misc__functions_gaee11d366f841cd34c9aa6ac8c7c49577}{Qore\+::backquote}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} cmd, \+\_\+\+\_\+7\+\_\+ reference$<$ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} $>$ rc) \begin{DoxyCompactList}\small\item\em Executes a process and returns a string of the output (stdout only) \end{DoxyCompactList}\item nothing \mbox{\hyperlink{group__misc__functions_ga1d71fa075b5fd841df08e05cfdfc95c6}{Qore\+::backquote}} () \begin{DoxyCompactList}\small\item\em This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \end{DoxyCompactList}\item auto \mbox{\hyperlink{group__misc__functions_ga2a5c3efd9bd910e4cf85824b674525ad}{Qore\+::call\+\_\+builtin\+\_\+function}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} name,...) \begin{DoxyCompactList}\small\item\em Calls a function and returns the return value, passing the remaining arguments after the function name to the builtin function. \end{DoxyCompactList}\item auto \mbox{\hyperlink{group__misc__functions_ga4e3a83f320bb7228614a48a607325c5b}{Qore\+::call\+\_\+builtin\+\_\+function\+\_\+args}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} name, \+\_\+\+\_\+7\+\_\+ softlist$<$ auto $>$ vargs) \begin{DoxyCompactList}\small\item\em Calls a function and returns the return value, using the optional second argument as a list of arguments for the function. \end{DoxyCompactList}\item auto \mbox{\hyperlink{group__misc__functions_ga7540367a4c8ba030499a7ad50f8b4d92}{Qore\+::call\+\_\+function}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} name,...) \begin{DoxyCompactList}\small\item\em Calls a function and returns the return value, passing the remaining arguments after the function name to the function. \end{DoxyCompactList}\item auto \mbox{\hyperlink{group__misc__functions_gae83a1a257c36f235bfaaba52583553ac}{Qore\+::call\+\_\+function}} (code f,...) \begin{DoxyCompactList}\small\item\em Calls the given \mbox{\hyperlink{expressions_call_reference}{call reference}} or \mbox{\hyperlink{expressions_closure}{closure}} and returns the result, passing the remaining arguments to the \mbox{\hyperlink{expressions_call_reference}{call reference}} or \mbox{\hyperlink{expressions_closure}{closure}}. \end{DoxyCompactList}\item auto \mbox{\hyperlink{group__misc__functions_ga186059954046920e50aa418739638b8e}{Qore\+::call\+\_\+function\+\_\+args}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} name, \+\_\+\+\_\+7\+\_\+ softlist$<$ auto $>$ vargs) \begin{DoxyCompactList}\small\item\em Calls a function and returns the return value, using the optional second argument as a list of arguments for the function. \end{DoxyCompactList}\item auto \mbox{\hyperlink{group__misc__functions_ga85bd0d8e44d4011c85bc57fbebd99482}{Qore\+::call\+\_\+function\+\_\+args}} (code f, \+\_\+\+\_\+7\+\_\+ softlist$<$ auto $>$ vargs) \begin{DoxyCompactList}\small\item\em Calls the given \mbox{\hyperlink{expressions_call_reference}{call reference}} or \mbox{\hyperlink{expressions_closure}{closure}} and returns the result, using the optional second argument as a list of arguments to the \mbox{\hyperlink{expressions_call_reference}{call reference}} or \mbox{\hyperlink{expressions_closure}{closure}}. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{group__misc__functions_gafd6a2b1500aca8b73c112b723695af4f}{Qore\+::decode\+\_\+uri\+\_\+request}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} uri) \begin{DoxyCompactList}\small\item\em Decodes percent-\/encoded codes in a URI path and converts {\ttfamily \char`\"{}+\char`\"{}} signs in the query component to spaces and returns the decoded string in UTF-\/8 encoding. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{group__misc__functions_ga51b949c2d20900fdc2e1b8e46988d2b1}{Qore\+::decode\+\_\+url}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} url) \begin{DoxyCompactList}\small\item\em Decodes percent numeric codes in a URL string and returns the decoded string in UTF-\/8 encoding. \end{DoxyCompactList}\item nothing \mbox{\hyperlink{group__misc__functions_ga2f5349505d3d2563ef31f4d8b5c5f1b3}{Qore\+::decode\+\_\+url}} () \begin{DoxyCompactList}\small\item\em This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{group__misc__functions_gad0bbcfc5357d459cb538e57e85c1971e}{Qore\+::encode\+\_\+uri\+\_\+request}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} url) \begin{DoxyCompactList}\small\item\em Encodes URI requests by substituting special characters in the path with percent-\/encoded equivalents and substituting spaces with {\ttfamily \char`\"{}+\char`\"{}} and {\ttfamily \char`\"{}+\char`\"{}} with the percent-\/encoded equivalent in the URI query component. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{group__misc__functions_ga639fba8c278c69ac4d4190ca1db19235}{Qore\+::encode\+\_\+url}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} url, softbool encode\+\_\+all=\mbox{\hyperlink{group__boolean__constants_ga9da2b9a8003cd3788e48305f8a00540f}{False}}) \begin{DoxyCompactList}\small\item\em Encodes URLs by substituting {\ttfamily \textquotesingle{}\%\textquotesingle{}} characters with {\ttfamily \textquotesingle{}\%25\textquotesingle{}}, spaces ({\ttfamily \textquotesingle{}} \textquotesingle{}) with {\ttfamily \textquotesingle{}\%20\textquotesingle{}}, and non-\/ascii characters by percent-\/encoded representations. \end{DoxyCompactList}\item bool \mbox{\hyperlink{group__misc__functions_gad1e87cdb4aded090b1801d952e018a50}{Qore\+::exists}} (...) \begin{DoxyCompactList}\small\item\em A function performing the same role as the \mbox{\hyperlink{operators_exists}{exists operator}}. \end{DoxyCompactList}\item bool \mbox{\hyperlink{group__misc__functions_ga83615e15094fca9ffe868ee0d80cd002}{Qore\+::exists\+Function}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} name) \begin{DoxyCompactList}\small\item\em Returns \mbox{\hyperlink{basic_data_types_True}{True}} if the function exists in the current program\textquotesingle{}s function name space. \end{DoxyCompactList}\item bool \mbox{\hyperlink{group__misc__functions_gaa3aa518a4c17e2593c2773bc6b71af3c}{Qore\+::exists\+Function}} (code c) \begin{DoxyCompactList}\small\item\em Always returns \mbox{\hyperlink{basic_data_types_True}{True}}. \end{DoxyCompactList}\item nothing \mbox{\hyperlink{group__misc__functions_gac6b3861f291cf4c2f62742fc8ec9b717}{Qore\+::exists\+Function}} () \begin{DoxyCompactList}\small\item\em This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \end{DoxyCompactList}\item bool \mbox{\hyperlink{group__misc__functions_ga3a1dcf3c8f3908896ca2aabfcc41010c}{Qore\+::exists\+\_\+function}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} name) \begin{DoxyCompactList}\small\item\em Returns \mbox{\hyperlink{basic_data_types_True}{True}} if the function exists in the current program\textquotesingle{}s function name space. \end{DoxyCompactList}\item bool \mbox{\hyperlink{group__misc__functions_gad985bd6dcc2a74fd36c087881d21b40c}{Qore\+::exists\+\_\+function}} (code c) \begin{DoxyCompactList}\small\item\em Always returns \mbox{\hyperlink{basic_data_types_True}{True}}. \end{DoxyCompactList}\item \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{group__misc__functions_ga5ae2be041abe7d02be8a2ccc67c0032f}{Qore\+::function\+Type}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} name) \begin{DoxyCompactList}\small\item\em Returns {\ttfamily \char`\"{}builtin\char`\"{}} (for a builtin function), {\ttfamily \char`\"{}user\char`\"{}} (for a user function), or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} (if the function cannot be found) according to the function name passed. \end{DoxyCompactList}\item nothing \mbox{\hyperlink{group__misc__functions_gaf46dfa4dc44e9e7091e981c87ebbe438}{Qore\+::function\+Type}} () \begin{DoxyCompactList}\small\item\em This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \end{DoxyCompactList}\item \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{group__misc__functions_ga23f1e7651ff70e32e9ba7c28907b1306}{Qore\+::function\+\_\+type}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} name) \begin{DoxyCompactList}\small\item\em Returns {\ttfamily \char`\"{}builtin\char`\"{}} (for a builtin function), {\ttfamily \char`\"{}user\char`\"{}} (for a user function), or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} (if the function cannot be found) according to the function name passed. \end{DoxyCompactList}\item \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} \mbox{\hyperlink{group__misc__functions_ga3a6b906bee63eb28d20610da64fd5417}{Qore\+::get\+Byte}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} str, softint offset=0) \begin{DoxyCompactList}\small\item\em Returns the byte value at the given byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. \end{DoxyCompactList}\item nothing \mbox{\hyperlink{group__misc__functions_gadfbef79c0c3442d2d7857f6ba1d56049}{Qore\+::get\+Byte}} () \begin{DoxyCompactList}\small\item\em This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \end{DoxyCompactList}\item \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} \mbox{\hyperlink{group__misc__functions_gad79fe036448819f5e392ef443b60b97d}{Qore\+::get\+Byte}} (\mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}} b, softint offset=0) \begin{DoxyCompactList}\small\item\em Returns the byte value at the given byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{group__misc__functions_ga46b9c2df48897cb68e765cb6d66728ac}{Qore\+::get\+Class\+Name}} (object obj) \begin{DoxyCompactList}\small\item\em Returns the class name of the object passed. \end{DoxyCompactList}\item nothing \mbox{\hyperlink{group__misc__functions_ga69cdaa7f57458a60221fbed9ac2feb38}{Qore\+::get\+Class\+Name}} () \begin{DoxyCompactList}\small\item\em This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_ga4b52a1cbee7a3aed46c32cb0a938629c}{list}}$<$ \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} $>$ \mbox{\hyperlink{group__misc__functions_ga82a9721ba77a2a344b0e356d45c5a37f}{Qore\+::get\+Feature\+List}} () \begin{DoxyCompactList}\small\item\em Returns a list of strings of the builtin and module-\/supplied features of \mbox{\hyperlink{namespace_qore}{Qore}}. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$ \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}, \mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$ auto $>$ $>$ \mbox{\hyperlink{group__misc__functions_ga34248adafed4b00da2a526f8f23017cf}{Qore\+::get\+Module\+Hash}} () \begin{DoxyCompactList}\small\item\em Returns a hash of hashes describing the currently-\/loaded Qore modules; the top-\/level hash keys are the module names. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_ga4b52a1cbee7a3aed46c32cb0a938629c}{list}}$<$ \mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$ auto $>$ $>$ \mbox{\hyperlink{group__misc__functions_ga82506074037fe39372ea4f44e2582a75}{Qore\+::get\+Module\+List}} () \begin{DoxyCompactList}\small\item\em Returns a list of hashes describing the currently-\/loaded Qore modules. \end{DoxyCompactList}\item \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} \mbox{\hyperlink{group__misc__functions_gaed6fd3c7569dbd820cff0fc1e23db555}{Qore\+::get\+Word32}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} str, softint offset=0) \begin{DoxyCompactList}\small\item\em Returns the 32-\/bit integer value at the given 4-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. \end{DoxyCompactList}\item \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} \mbox{\hyperlink{group__misc__functions_ga771e2f1f122ccd8574354abdff42c192}{Qore\+::get\+Word32}} (\mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}} b, softint offset=0) \begin{DoxyCompactList}\small\item\em Returns the 32-\/bit integer value at the given 4-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. \end{DoxyCompactList}\item nothing \mbox{\hyperlink{group__misc__functions_ga11bb1ea838d7c14802f3810ed0cbfdb2}{Qore\+::get\+Word32}} () \begin{DoxyCompactList}\small\item\em This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \end{DoxyCompactList}\item \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} \mbox{\hyperlink{group__misc__functions_ga24aed47f45573187b6644d5ec1a3aeb5}{Qore\+::get\+\_\+byte}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} str, softint offset=0) \begin{DoxyCompactList}\small\item\em Returns the byte value at the given byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. \end{DoxyCompactList}\item \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} \mbox{\hyperlink{group__misc__functions_ga8a7ea9de612741d9bb26bf926d211c71}{Qore\+::get\+\_\+byte}} (\mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}} b, softint offset=0) \begin{DoxyCompactList}\small\item\em Returns the byte value at the given byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. \end{DoxyCompactList}\item code \mbox{\hyperlink{group__misc__functions_ga6b730c0585f1fe62929d6877c32ee0c7}{Qore\+::get\+\_\+call\+\_\+reference}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} identifier) \begin{DoxyCompactList}\small\item\em resolve the string as a call reference \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{group__misc__functions_gaa9a0d3f277ef8cbdc99fe146dd3db49b}{Qore\+::get\+\_\+class\+\_\+name}} (object obj) \begin{DoxyCompactList}\small\item\em Returns the class name of the object passed. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{group__misc__functions_ga8f800bec17c55a15ec7255dedfa25c6d}{Qore\+::get\+\_\+default\+\_\+encoding}} () \begin{DoxyCompactList}\small\item\em Returns the name of the \mbox{\hyperlink{character_encoding_default_encoding}{default character encoding}}. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{group__misc__functions_gaaa60e9a984c59e662b2e7cac84a3899d}{Qore\+::get\+\_\+ex\+\_\+pos}} (\mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$ auto $>$ ex) \begin{DoxyCompactList}\small\item\em returns a descriptive string for an exception location; the {\ttfamily source} and {\ttfamily offset} information will also be included in the string returned if present in the \mbox{\hyperlink{struct_qore_1_1_exception_info}{Exception\+Info}} hash argument \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_ga4b52a1cbee7a3aed46c32cb0a938629c}{list}}$<$ \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} $>$ \mbox{\hyperlink{group__misc__functions_ga86de08439e084c19460ae57d3d6269e5}{Qore\+::get\+\_\+feature\+\_\+list}} () \begin{DoxyCompactList}\small\item\em Returns a list of strings of the builtin and module-\/supplied features of \mbox{\hyperlink{namespace_qore}{Qore}}. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$ auto $>$ \mbox{\hyperlink{group__misc__functions_ga35f238f6343017d7e4736cd2c3007752}{Qore\+::get\+\_\+global\+\_\+vars}} () \begin{DoxyCompactList}\small\item\em returns a hash of global variables \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$ auto $>$ \mbox{\hyperlink{group__misc__functions_gac3c60c8fa6766bc3e6809468acca8465}{Qore\+::get\+\_\+local\+\_\+vars}} (\mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} frame) \begin{DoxyCompactList}\small\item\em retrieves a hash of local variables for the given stack frame \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$ \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}, \mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$ auto $>$ $>$ \mbox{\hyperlink{group__misc__functions_gab64b871ddf6f09568d4a0798c0ca755a}{Qore\+::get\+\_\+module\+\_\+hash}} () \begin{DoxyCompactList}\small\item\em Returns a hash of hashes describing the currently-\/loaded Qore modules; the top-\/level hash keys are the module names. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_ga4b52a1cbee7a3aed46c32cb0a938629c}{list}}$<$ \mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$ auto $>$ $>$ \mbox{\hyperlink{group__misc__functions_ga18cc840553c5850216308dbefa9d5a78}{Qore\+::get\+\_\+module\+\_\+list}} () \begin{DoxyCompactList}\small\item\em Returns a list of hashes describing the currently-\/loaded Qore modules. \end{DoxyCompactList}\item auto \mbox{\hyperlink{group__misc__functions_ga26bb5a87af0e8be0e661a590fb722c83}{Qore\+::get\+\_\+module\+\_\+option}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} module, \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} option) \begin{DoxyCompactList}\small\item\em returns the given global module option \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} \mbox{\hyperlink{group__misc__functions_ga6b1422bc842cbf53cf2bb53ef9322209}{Qore\+::get\+\_\+parse\+\_\+options}} () \begin{DoxyCompactList}\small\item\em returns the current \mbox{\hyperlink{group__parse__options}{parse options}} for the current \mbox{\hyperlink{class_qore_1_1_program}{Program}} object \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$ auto $>$ \mbox{\hyperlink{group__misc__functions_gaa0c7ff8f74f88213fdcee6fd6082b16d}{Qore\+::get\+\_\+qore\+\_\+library\+\_\+info}} () \begin{DoxyCompactList}\small\item\em Returns a hash of library build and version info. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$ \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}, \mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$ auto $>$ $>$ \mbox{\hyperlink{group__misc__functions_ga1fe51f94becc8165b08426434fe4f138}{Qore\+::get\+\_\+qore\+\_\+option\+\_\+hash}} () \begin{DoxyCompactList}\small\item\em Returns a hash of hashes giving information about Qore library options for the current build. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_ga4b52a1cbee7a3aed46c32cb0a938629c}{list}}$<$ \mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$ auto $>$ $>$ \mbox{\hyperlink{group__misc__functions_ga8ed2c5a0ee827317e265808c8f872a74}{Qore\+::get\+\_\+qore\+\_\+option\+\_\+list}} () \begin{DoxyCompactList}\small\item\em Returns a list of hashes giving information about Qore library options for the current build. \end{DoxyCompactList}\item \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{group__misc__functions_ga4730f5a695996be26efbfa9760417b1b}{Qore\+::get\+\_\+script\+\_\+dir}} () \begin{DoxyCompactList}\small\item\em Returns the name of the directory from which the current script was executed or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if unknown (i.\+e. no parent script, script read from stdin, etc) \end{DoxyCompactList}\item \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{group__misc__functions_gade1f45f4d12597822362d920c84695a5}{Qore\+::get\+\_\+script\+\_\+name}} () \begin{DoxyCompactList}\small\item\em Returns the filename of the current script if known or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if unknown (i.\+e. no parent script, script read from stdin, etc) \end{DoxyCompactList}\item \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{group__misc__functions_ga3ebc5d7d350677395e4b89686ca335b4}{Qore\+::get\+\_\+script\+\_\+path}} () \begin{DoxyCompactList}\small\item\em Returns the path (directory and filename) of the current script or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if unknown (i.\+e. no parent script, script read from stdin, etc) \end{DoxyCompactList}\item \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} \mbox{\hyperlink{group__misc__functions_ga5802a4f147d02009947401dd92e3b197}{Qore\+::get\+\_\+word\+\_\+16}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} str, softint offset=0) \begin{DoxyCompactList}\small\item\em Returns the 16-\/bit integer value at the given 2-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. \end{DoxyCompactList}\item \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} \mbox{\hyperlink{group__misc__functions_gad19c4c14c864af9759effecbfef6d68a}{Qore\+::get\+\_\+word\+\_\+16}} (\mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}} b, softint offset=0) \begin{DoxyCompactList}\small\item\em Returns the 16-\/bit integer value at the given 2-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. \end{DoxyCompactList}\item \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} \mbox{\hyperlink{group__misc__functions_ga8d9d7eb06b650954226a82502dcaa838}{Qore\+::get\+\_\+word\+\_\+16\+\_\+lsb}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} str, softint offset=0) \begin{DoxyCompactList}\small\item\em Returns the 16-\/bit integer value at the given 2-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. \end{DoxyCompactList}\item \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} \mbox{\hyperlink{group__misc__functions_ga28d6b93d58fb1df8615a9701fa10fe52}{Qore\+::get\+\_\+word\+\_\+16\+\_\+lsb}} (\mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}} b, softint offset=0) \begin{DoxyCompactList}\small\item\em Returns the 16-\/bit integer value at the given 2-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. \end{DoxyCompactList}\item \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} \mbox{\hyperlink{group__misc__functions_gae5d20bf535d84eee3ae17402b3ac4ec7}{Qore\+::get\+\_\+word\+\_\+32}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} str, softint offset=0) \begin{DoxyCompactList}\small\item\em Returns the 32-\/bit integer value at the given 4-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. \end{DoxyCompactList}\item \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} \mbox{\hyperlink{group__misc__functions_ga1124c85d897be618a9e61c1fbccd37d9}{Qore\+::get\+\_\+word\+\_\+32}} (\mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}} b, softint offset=0) \begin{DoxyCompactList}\small\item\em Returns the 32-\/bit integer value at the given 4-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. \end{DoxyCompactList}\item \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} \mbox{\hyperlink{group__misc__functions_ga29b56ac9ee5c55bf8243b3060388be02}{Qore\+::get\+\_\+word\+\_\+32\+\_\+lsb}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} str, softint offset=0) \begin{DoxyCompactList}\small\item\em Returns the 32-\/bit integer value at the given 4-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. \end{DoxyCompactList}\item \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} \mbox{\hyperlink{group__misc__functions_ga2269ca395fdfe9214039952c4cacf730}{Qore\+::get\+\_\+word\+\_\+32\+\_\+lsb}} (\mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}} b, softint offset=0) \begin{DoxyCompactList}\small\item\em Returns the 32-\/bit integer value at the given 4-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. \end{DoxyCompactList}\item \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} \mbox{\hyperlink{group__misc__functions_gadf53ee1d46382bf4cb2c4fd12816a5c8}{Qore\+::get\+\_\+word\+\_\+64}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} str, softint offset=0) \begin{DoxyCompactList}\small\item\em Returns the 64-\/bit integer value at the given 8-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. \end{DoxyCompactList}\item \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} \mbox{\hyperlink{group__misc__functions_ga6fbc2c59ad0af1fe6a9e87b6f037d331}{Qore\+::get\+\_\+word\+\_\+64}} (\mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}} b, softint offset=0) \begin{DoxyCompactList}\small\item\em Returns the 64-\/bit integer value at the given 8-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. \end{DoxyCompactList}\item \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} \mbox{\hyperlink{group__misc__functions_gac260e3cfffb2c9ac8e69a1428183de01}{Qore\+::get\+\_\+word\+\_\+64\+\_\+lsb}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} str, softint offset=0) \begin{DoxyCompactList}\small\item\em Returns the 64-\/bit integer value at the given 8-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. \end{DoxyCompactList}\item \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} \mbox{\hyperlink{group__misc__functions_ga08294fc87d5f9d127cdd794085c59072}{Qore\+::get\+\_\+word\+\_\+64\+\_\+lsb}} (\mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}} b, softint offset=0) \begin{DoxyCompactList}\small\item\em Returns the 64-\/bit integer value at the given 8-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. \end{DoxyCompactList}\item bool \mbox{\hyperlink{group__misc__functions_ga6e0d48075f4f39939f6354aa7060e5b4}{Qore\+::has\+\_\+key}} (\mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$ auto $>$ h, \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} key) \begin{DoxyCompactList}\small\item\em Returns \mbox{\hyperlink{basic_data_types_True}{True}} if the given key exists in the hash (does not necessarily have to have a value assigned); exceptions are only raised if string encoding errors are encountered. \end{DoxyCompactList}\item bool \mbox{\hyperlink{group__misc__functions_ga5cf258d64631c0422ee15e0796361b28}{Qore\+::has\+\_\+key}} (object obj, \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} key) \begin{DoxyCompactList}\small\item\em Returns \mbox{\hyperlink{basic_data_types_True}{True}} if the given key exists in the object (does not necessarily have to have a value assigned); exceptions are only raised if string encoding errors are encountered or in case of object access errors. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_ga4b52a1cbee7a3aed46c32cb0a938629c}{list}}$<$ auto $>$ \mbox{\hyperlink{group__misc__functions_gaf5d769ebf4e89f22c223f36beacf5000}{Qore\+::hash\+\_\+values}} (\mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$ auto $>$ h) \begin{DoxyCompactList}\small\item\em Returns a list of all the values in the hash argument passed. \end{DoxyCompactList}\item nothing \mbox{\hyperlink{group__misc__functions_ga6f07280e7c9ab676913b6fcb84588610}{Qore\+::hash\+\_\+values}} () \begin{DoxyCompactList}\small\item\em This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} \mbox{\hyperlink{group__misc__functions_ga635c21b4901af8accbf5729682b90f20}{Qore\+::hextoint}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} str) \begin{DoxyCompactList}\small\item\em Returns an integer for a hexadecimal string value; throws an exception if non-\/hex digits are found. \end{DoxyCompactList}\item nothing \mbox{\hyperlink{group__misc__functions_ga54d9807bf59a9e97284b12542a4c3ec6}{Qore\+::hextoint}} () \begin{DoxyCompactList}\small\item\em This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{group__misc__functions_gac6f51f8c4de37bc139346d6059961148}{Qore\+::html\+\_\+decode}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} str) \begin{DoxyCompactList}\small\item\em Returns a string with any HTML escape codes translated to the original characters. \end{DoxyCompactList}\item nothing \mbox{\hyperlink{group__misc__functions_gad95ece28621404a42cf5e3f80193c84d}{Qore\+::html\+\_\+decode}} () \begin{DoxyCompactList}\small\item\em This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{group__misc__functions_ga98e1d9690329e8c94f88b833af36ef72}{Qore\+::html\+\_\+encode}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} str) \begin{DoxyCompactList}\small\item\em Returns a string with characters needing HTML escaping translated to HTML escape codes. \end{DoxyCompactList}\item nothing \mbox{\hyperlink{group__misc__functions_ga26f2cfc2d0d972642e82eedc09d097cc}{Qore\+::html\+\_\+encode}} () \begin{DoxyCompactList}\small\item\em This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \end{DoxyCompactList}\item nothing \mbox{\hyperlink{group__misc__functions_gaf0922a51e6c5471b02a947cb0cb008ba}{Qore\+::load\+\_\+module}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} name, \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} warning\+\_\+mask=\mbox{\hyperlink{group__warning__constants_ga7f704aa8f7652702d72d22ce93125566}{WARN\+\_\+\+MODULES}}) \begin{DoxyCompactList}\small\item\em Loads in a Qore module at run-\/time. \end{DoxyCompactList}\item nothing \mbox{\hyperlink{group__misc__functions_ga366da9b19ed9b6fb4936f5e5a2ff3663}{Qore\+::load\+\_\+module}} () \begin{DoxyCompactList}\small\item\em This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \end{DoxyCompactList}\item \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$ \mbox{\hyperlink{struct_qore_1_1_exception_info}{Exception\+Info}} $>$ \mbox{\hyperlink{group__misc__functions_ga24b04239fa5f45bd1c3d430dfab49019}{Qore\+::load\+\_\+module\+\_\+warn}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} name, \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} warning\+\_\+mask=\mbox{\hyperlink{group__warning__constants_ga7f704aa8f7652702d72d22ce93125566}{WARN\+\_\+\+MODULES}}) \begin{DoxyCompactList}\small\item\em Loads in a Qore module at run-\/time. \end{DoxyCompactList}\item nothing \mbox{\hyperlink{group__misc__functions_ga59d94b7cc4dfcc6e39030097458b8afe}{Qore\+::load\+\_\+user\+\_\+module\+\_\+with\+\_\+program}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} name, \mbox{\hyperlink{class_qore_1_1_program}{Qore\+::\+Program}} pgm) \begin{DoxyCompactList}\small\item\em Loads in a Qore user module at run-\/time with using the given \mbox{\hyperlink{class_qore_1_1_program}{Program}} object as the container for the user module code. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{group__misc__functions_ga302de285f031c3dd4b059df3494bd21c}{Qore\+::make\+Base64\+String}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} str, softint maxlinelen=-\/1) \begin{DoxyCompactList}\small\item\em Returns a base64-\/encoded representation of a string. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{group__misc__functions_ga511ce458d13dfbea8c22ece63c315bb7}{Qore\+::make\+Base64\+String}} (\mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}} bin, softint maxlinelen=-\/1) \begin{DoxyCompactList}\small\item\em Returns a base64-\/encoded representation of a binary object. \end{DoxyCompactList}\item nothing \mbox{\hyperlink{group__misc__functions_ga1d5d34fd58d766f2eacde5701f5a99ae}{Qore\+::make\+Base64\+String}} () \begin{DoxyCompactList}\small\item\em This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{group__misc__functions_gae4ca24e1000d327df636f75c7bf4f00c}{Qore\+::make\+Hex\+String}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} str) \begin{DoxyCompactList}\small\item\em Returns a hex-\/encoded representation of a string. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{group__misc__functions_gaafe286db27d58cea75749c1bdabb5ad0}{Qore\+::make\+Hex\+String}} (\mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}} bin) \begin{DoxyCompactList}\small\item\em Returns a hex-\/encoded representation of a binary object. \end{DoxyCompactList}\item nothing \mbox{\hyperlink{group__misc__functions_gacb04ca5bd37d873b867186c4da295f0c}{Qore\+::make\+Hex\+String}} () \begin{DoxyCompactList}\small\item\em This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{group__misc__functions_ga8de429a31ac854f93c8c66e14baaaf66}{Qore\+::make\+\_\+base64\+\_\+string}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} str, softint maxlinelen=-\/1) \begin{DoxyCompactList}\small\item\em Returns a base64-\/encoded representation of a string. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{group__misc__functions_gaba5bd6118895a5f84c03c6a82968a37f}{Qore\+::make\+\_\+base64\+\_\+string}} (\mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}} bin, softint maxlinelen=-\/1) \begin{DoxyCompactList}\small\item\em Returns a base64-\/encoded representation of a binary object. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{group__misc__functions_gae7be18717b0ed9010c48166a437c35b4}{Qore\+::make\+\_\+hex\+\_\+string}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} str) \begin{DoxyCompactList}\small\item\em Returns a hex-\/encoded representation of a string. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{group__misc__functions_gabc590f8b24ce809f2e5caa7b3ab7ed19}{Qore\+::make\+\_\+hex\+\_\+string}} (\mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}} bin) \begin{DoxyCompactList}\small\item\em Returns a hex-\/encoded representation of a binary object. \end{DoxyCompactList}\item \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$ auto $>$ \mbox{\hyperlink{group__misc__functions_ga11da5fd06dcfa57a48a5381268a52086}{Qore\+::parse}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} code, \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} label, \+\_\+\+\_\+7\+\_\+ softint warning\+\_\+mask, \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} source, \+\_\+\+\_\+7\+\_\+ softint offset, softbool format\+\_\+label=\mbox{\hyperlink{group__boolean__constants_ga3ba2df91713a6249449347131ea526c3}{True}}) \begin{DoxyCompactList}\small\item\em Adds the text passed to the current program\textquotesingle{}s code, tagged with the given label. \end{DoxyCompactList}\item nothing \mbox{\hyperlink{group__misc__functions_ga6c7d460b97c3c862717b052355985ded}{Qore\+::parse}} () \begin{DoxyCompactList}\small\item\em This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}} \mbox{\hyperlink{group__misc__functions_ga1e6e24f780713c4d10cb9b98fa45cd35}{Qore\+::parse\+Base64\+String}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} str) \begin{DoxyCompactList}\small\item\em Parses a base64 encoded string and returns a binary object of the decoded data. \end{DoxyCompactList}\item nothing \mbox{\hyperlink{group__misc__functions_ga0c3bdfd8fb3a29af0d3bcd0ed3a05eb0}{Qore\+::parse\+Base64\+String}} () \begin{DoxyCompactList}\small\item\em This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{group__misc__functions_ga1f1a63790a7c60a3a61c5d1569fe4e4c}{Qore\+::parse\+Base64\+String\+To\+String}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} str, \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} encoding) \begin{DoxyCompactList}\small\item\em Parses a base64 encoded string and returns a string of the decoded data. \end{DoxyCompactList}\item nothing \mbox{\hyperlink{group__misc__functions_ga8851e308445e0388408b8b2cca344088}{Qore\+::parse\+Base64\+String\+To\+String}} () \begin{DoxyCompactList}\small\item\em This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}} \mbox{\hyperlink{group__misc__functions_ga74fed7603d2176dd5d433d3fae02ad9f}{Qore\+::parse\+Hex\+String}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} hexstr) \begin{DoxyCompactList}\small\item\em Parses a hex-\/encoded string and returns the binary object. \end{DoxyCompactList}\item nothing \mbox{\hyperlink{group__misc__functions_ga64ee3ae01383697ae0174fd0cf6cbc5e}{Qore\+::parse\+Hex\+String}} () \begin{DoxyCompactList}\small\item\em This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \end{DoxyCompactList}\item \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$ \mbox{\hyperlink{struct_qore_1_1_url_info}{Url\+Info}} $>$ \mbox{\hyperlink{group__misc__functions_gae1961be84af7e6bc5553049bf978f922}{Qore\+::parse\+URL}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} url, bool keep\+\_\+brackets=\mbox{\hyperlink{group__boolean__constants_ga9da2b9a8003cd3788e48305f8a00540f}{False}}) \begin{DoxyCompactList}\small\item\em Parses a URL string and returns a hash of the components; if the URL cannot be parsed then \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} is returned. \end{DoxyCompactList}\item nothing \mbox{\hyperlink{group__misc__functions_gad2514f74637e1955648b867103aea595}{Qore\+::parse\+URL}} () \begin{DoxyCompactList}\small\item\em This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}} \mbox{\hyperlink{group__misc__functions_ga34c9bccc1d1e61d6a8a8988ceb4a8a6c}{Qore\+::parse\+\_\+base64\+\_\+string}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} str) \begin{DoxyCompactList}\small\item\em Parses a base64 encoded string and returns a binary object of the decoded data. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{group__misc__functions_ga0160c0c4cbe7180d70048577e4e40bcc}{Qore\+::parse\+\_\+base64\+\_\+string\+\_\+to\+\_\+string}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} str, \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} encoding) \begin{DoxyCompactList}\small\item\em Parses a base64 encoded string and returns a string of the decoded data. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}} \mbox{\hyperlink{group__misc__functions_gaedf4a2c140fa284c9e09a68b743763b3}{Qore\+::parse\+\_\+hex\+\_\+string}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} hexstr) \begin{DoxyCompactList}\small\item\em Parses a hex-\/encoded string and returns the binary object. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$ \mbox{\hyperlink{struct_qore_1_1_url_info}{Url\+Info}} $>$ \mbox{\hyperlink{group__misc__functions_ga4e22308b56f16f8bd090e69ed3bad451}{Qore\+::parse\+\_\+url}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} url, bool keep\+\_\+brackets) \begin{DoxyCompactList}\small\item\em Parses a URL string and returns a hash of the components. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$ \mbox{\hyperlink{struct_qore_1_1_url_info}{Url\+Info}} $>$ \mbox{\hyperlink{group__misc__functions_gad08ab1d19f1e77fbaa3d1a3d626ee45c}{Qore\+::parse\+\_\+url}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} url, \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} options) \begin{DoxyCompactList}\small\item\em Parses a URL string and returns a hash of the components. \end{DoxyCompactList}\item nothing \mbox{\hyperlink{group__misc__functions_ga84fcab69e514fd31cefe8de51bbe8acd}{Qore\+::reload\+\_\+module}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} name) \begin{DoxyCompactList}\small\item\em Reloads an already-\/loaded Qore module subject to code injection at run-\/time into Qore; the module\textquotesingle{}s code is not imported into the current \mbox{\hyperlink{class_qore_1_1_program}{Program}} object. \end{DoxyCompactList}\item nothing \mbox{\hyperlink{group__misc__functions_gaea05595c0ea4cf4affef51c323c7eed1}{Qore\+::set\+\_\+global\+\_\+var\+\_\+value}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} name, auto value) \begin{DoxyCompactList}\small\item\em set the value of a global variable \end{DoxyCompactList}\item nothing \mbox{\hyperlink{group__misc__functions_ga20e0c1f20a6afc4b02dbd9862996d57a}{Qore\+::set\+\_\+local\+\_\+var\+\_\+value}} (\mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} frame, \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} var, auto value) \begin{DoxyCompactList}\small\item\em sets the value of the given local variable; if the variable cannot be found an exception is raised \end{DoxyCompactList}\item nothing \mbox{\hyperlink{group__misc__functions_ga9034376bb44beb761d76156600b537f8}{Qore\+::set\+\_\+module\+\_\+option}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} module, \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} option, auto value) \begin{DoxyCompactList}\small\item\em set the given module option \end{DoxyCompactList}\item \mbox{\hyperlink{group__misc__functions_ga51444e624e7ba2b2ecfb45dd49e6db42}{Qore\+::set\+\_\+return\+\_\+value}} (auto val) \begin{DoxyCompactList}\small\item\em sets the return value for a \mbox{\hyperlink{class_qore_1_1_program}{Program}} object when running with \mbox{\hyperlink{parse_directives_exec-class}{\%exec-\/class}} \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{group__misc__functions_ga3b0fa637025e8fbacdf4e43c33e37dc8}{Qore\+::splice}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} str) \begin{DoxyCompactList}\small\item\em This function always returns an empty string {\ttfamily \char`\"{}\char`\"{}}. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{group__misc__functions_ga2d484582db42dcb4752812d3243552bc}{Qore\+::splice}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} str, softint start) \begin{DoxyCompactList}\small\item\em Returns a string based on the argument string but with characters removed from a certain character index. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} \mbox{\hyperlink{group__misc__functions_gaaf2f11a128064b10de5cd2ce1fec72d3}{Qore\+::splice}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} str, softint start, softint len, \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} nstr) \begin{DoxyCompactList}\small\item\em Returns a string based on the argument string but optionally with characters removed and/or added from a certain character index. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_ga4b52a1cbee7a3aed46c32cb0a938629c}{list}}$<$ auto $>$ \mbox{\hyperlink{group__misc__functions_ga8ef232e117e3b0848e59c97571817d59}{Qore\+::splice}} (\mbox{\hyperlink{group__type__conversion__functions_ga4b52a1cbee7a3aed46c32cb0a938629c}{list}}$<$ auto $>$ l, softint start) \begin{DoxyCompactList}\small\item\em Returns a list based on the argument list but with elements removed from the given index to the end of the list. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_ga4b52a1cbee7a3aed46c32cb0a938629c}{list}}$<$ auto $>$ \mbox{\hyperlink{group__misc__functions_gaf89a7fd2369fe278be96948e51b1a807}{Qore\+::splice}} (\mbox{\hyperlink{group__type__conversion__functions_ga4b52a1cbee7a3aed46c32cb0a938629c}{list}}$<$ auto $>$ l, softint start, softint len) \begin{DoxyCompactList}\small\item\em Returns a list based on the argument list but optionally with elements removed and/or added from a certain index. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_ga4b52a1cbee7a3aed46c32cb0a938629c}{list}}$<$ auto $>$ \mbox{\hyperlink{group__misc__functions_ga31f7af53c8c0c95199e6be8d9942440f}{Qore\+::splice}} (\mbox{\hyperlink{group__type__conversion__functions_ga4b52a1cbee7a3aed46c32cb0a938629c}{list}}$<$ auto $>$ l, softint start, softint len, softlist$<$ auto $>$ nlist) \begin{DoxyCompactList}\small\item\em Returns a list based on the argument list but optionally with elements removed and/or added from a certain index. \end{DoxyCompactList}\item nothing \mbox{\hyperlink{group__misc__functions_ga7434c1e84c31c32b816312e7a846e876}{Qore\+::splice}} () \begin{DoxyCompactList}\small\item\em This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \end{DoxyCompactList}\item \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} \mbox{\hyperlink{group__misc__functions_ga868cb227993d254a65afb9d21ccba9fe}{Qore\+::strtoint}} (\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} num, softint base=10) \begin{DoxyCompactList}\small\item\em parses a string representing a number in a configurable base and returns the integer \end{DoxyCompactList}\item nothing \mbox{\hyperlink{group__misc__functions_ga25647de5f63580b7d3af4b33c4f35702}{Qore\+::strtoint}} () \begin{DoxyCompactList}\small\item\em This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \end{DoxyCompactList}\end{DoxyCompactItemize} \doxysubsection{Detailed Description} Miscellaneous functions \doxysubsection{Function Documentation} \mbox{\Hypertarget{group__misc__functions_ga1d71fa075b5fd841df08e05cfdfc95c6}\label{group__misc__functions_ga1d71fa075b5fd841df08e05cfdfc95c6}} \index{Miscellaneous Functions@{Miscellaneous Functions}!backquote@{backquote}} \index{backquote@{backquote}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{backquote()}{backquote()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} {\footnotesize\ttfamily nothing Qore\+::backquote (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \begin{DoxyParagraph}{Restrictions\+:} \mbox{\hyperlink{group__parse__options_gaab2d8faa88f066837e100152187e6368}{Qore\+::\+PO\+\_\+\+NO\+\_\+\+EXTERNAL\+\_\+\+PROCESS}} \end{DoxyParagraph} \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_RUNTIME_NOOP}{RUNTIME\+\_\+\+NOOP}} \end{DoxyParagraph} \mbox{\Hypertarget{group__misc__functions_gaee11d366f841cd34c9aa6ac8c7c49577}\label{group__misc__functions_gaee11d366f841cd34c9aa6ac8c7c49577}} \index{Miscellaneous Functions@{Miscellaneous Functions}!backquote@{backquote}} \index{backquote@{backquote}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{backquote()}{backquote()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::backquote (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{cmd, }\item[{\+\_\+\+\_\+7\+\_\+ reference$<$ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} $>$}]{rc }\end{DoxyParamCaption})} Executes a process and returns a string of the output (stdout only) \begin{DoxyParagraph}{Restrictions\+:} \mbox{\hyperlink{group__parse__options_gaab2d8faa88f066837e100152187e6368}{Qore\+::\+PO\+\_\+\+NO\+\_\+\+EXTERNAL\+\_\+\+PROCESS}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em cmd} & The shell command to executed as a subprocess \\ \hline {\em rc} & an optional reference to an integer to return the return code of the process\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} The stdout of the shell command that was executed \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{int rc;} \DoxyCodeLine{string files = \mbox{\hyperlink{group__misc__functions_gaee11d366f841cd34c9aa6ac8c7c49577}{backquote}}(\textcolor{stringliteral}{"{}ls"{}}, \(\backslash\)rc);} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyExceptions}{Exceptions} {\em BACKQUOTE-\/\+ERROR} & An error occurred with the \mbox{\hyperlink{namespace_qore_a38309c0ab1c849afc031dd8547b1ac65}{fork()}} or opening the stdout pipe\\ \hline \end{DoxyExceptions} \begin{DoxySeeAlso}{See also} \begin{DoxyItemize} \item \mbox{\hyperlink{namespace_qore_ab480d27a192337309e6497158df8e54c}{system()}} \item \mbox{\hyperlink{operators_backquote_operator}{the backquote operator}} \end{DoxyItemize} \end{DoxySeeAlso} \begin{DoxySince}{Since} Qore 0.\+8.\+8 the {\itshape rc} argument was added \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_ga2a5c3efd9bd910e4cf85824b674525ad}\label{group__misc__functions_ga2a5c3efd9bd910e4cf85824b674525ad}} \index{Miscellaneous Functions@{Miscellaneous Functions}!call\_builtin\_function@{call\_builtin\_function}} \index{call\_builtin\_function@{call\_builtin\_function}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{call\_builtin\_function()}{call\_builtin\_function()}} {\footnotesize\ttfamily auto Qore\+::call\+\_\+builtin\+\_\+function (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{name, }\item[{}]{... }\end{DoxyParamCaption})} Calls a function and returns the return value, passing the remaining arguments after the function name to the builtin function. \begin{DoxyParams}{Parameters} {\em name} & The name of the builtin function to call \\ \hline {\em ...} & Any optional arguments to the function\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} The value returned by the called function \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{auto result = \mbox{\hyperlink{group__misc__functions_ga2a5c3efd9bd910e4cf85824b674525ad}{call\_builtin\_function}}(\textcolor{stringliteral}{"{}func\_name"{}}, arg1, arg2);} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyExceptions}{Exceptions} {\em INVALID-\/\+FUNCTION-\/\+ACCESS} & Parse options do not allow access to the function \\ \hline {\em NO-\/\+FUNCTION} & The function does not exist\\ \hline \end{DoxyExceptions} \begin{DoxyNote}{Note} The function called could also throw other exceptions \end{DoxyNote} \begin{DoxySince}{Since} 0.\+8.\+4 this function no longer restricts its search to builtin functions as as of \mbox{\hyperlink{namespace_qore}{Qore}} 0.\+8.\+4 builtin and user functions are stored identically internally; there is only one function implementation which can contain both builtin and user variants \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_ga4e3a83f320bb7228614a48a607325c5b}\label{group__misc__functions_ga4e3a83f320bb7228614a48a607325c5b}} \index{Miscellaneous Functions@{Miscellaneous Functions}!call\_builtin\_function\_args@{call\_builtin\_function\_args}} \index{call\_builtin\_function\_args@{call\_builtin\_function\_args}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{call\_builtin\_function\_args()}{call\_builtin\_function\_args()}} {\footnotesize\ttfamily auto Qore\+::call\+\_\+builtin\+\_\+function\+\_\+args (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{name, }\item[{\+\_\+\+\_\+7\+\_\+ softlist$<$ auto $>$}]{vargs }\end{DoxyParamCaption})} Calls a function and returns the return value, using the optional second argument as a list of arguments for the function. \begin{DoxyParams}{Parameters} {\em name} & The name of the builtin function to call \\ \hline {\em vargs} & Optionally a single argument to the function or a list of arguments to the function\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} The value returned by the called function \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{auto result = \mbox{\hyperlink{group__misc__functions_ga4e3a83f320bb7228614a48a607325c5b}{call\_builtin\_function\_args}}(\textcolor{stringliteral}{"{}func\_name"{}}, (arg1, arg2));} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyExceptions}{Exceptions} {\em INVALID-\/\+FUNCTION-\/\+ACCESS} & Parse options do not allow access to the function \\ \hline {\em NO-\/\+FUNCTION} & The function does not exist\\ \hline \end{DoxyExceptions} \begin{DoxyNote}{Note} The function called could also throw other exceptions \end{DoxyNote} \begin{DoxySince}{Since} 0.\+8.\+4 this function no longer restricts its search to builtin functions as as of \mbox{\hyperlink{namespace_qore}{Qore}} 0.\+8.\+4 builtin and user functions are stored identically internally; there is only one function implementation which can contain both builtin and user variants \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_gae83a1a257c36f235bfaaba52583553ac}\label{group__misc__functions_gae83a1a257c36f235bfaaba52583553ac}} \index{Miscellaneous Functions@{Miscellaneous Functions}!call\_function@{call\_function}} \index{call\_function@{call\_function}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{call\_function()}{call\_function()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} {\footnotesize\ttfamily auto Qore\+::call\+\_\+function (\begin{DoxyParamCaption}\item[{code}]{f, }\item[{}]{... }\end{DoxyParamCaption})} Calls the given \mbox{\hyperlink{expressions_call_reference}{call reference}} or \mbox{\hyperlink{expressions_closure}{closure}} and returns the result, passing the remaining arguments to the \mbox{\hyperlink{expressions_call_reference}{call reference}} or \mbox{\hyperlink{expressions_closure}{closure}}. \begin{DoxyParams}{Parameters} {\em f} & The \mbox{\hyperlink{expressions_call_reference}{call reference}} or \mbox{\hyperlink{expressions_closure}{closure}} \\ \hline {\em ...} & Any optional arguments to the \mbox{\hyperlink{expressions_call_reference}{call reference}} or \mbox{\hyperlink{expressions_closure}{closure}}\\ \hline \end{DoxyParams} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{auto result = \mbox{\hyperlink{group__misc__functions_ga7540367a4c8ba030499a7ad50f8b4d92}{call\_function}}(call\_ref, arg1, arg2);} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyNote}{Note} The \mbox{\hyperlink{expressions_call_reference}{call reference}} or \mbox{\hyperlink{expressions_closure}{closure}} called could also throw other exceptions \end{DoxyNote} \begin{DoxySeeAlso}{See also} \begin{DoxyItemize} \item \mbox{\hyperlink{group__misc__functions_ga186059954046920e50aa418739638b8e}{call\+\_\+function\+\_\+args()}} \item \mbox{\hyperlink{group__object__functions_ga46a72b2a2a84282c5125b6fd7a2e6b23}{call\+\_\+static\+\_\+method()}} \item \mbox{\hyperlink{group__object__functions_gaf3059a3551575f93e04f2f58ae0ab4c4}{call\+\_\+static\+\_\+method\+\_\+args()}} \item \mbox{\hyperlink{group__object__functions_ga733217c233efed0557e133a6cc45189f}{call\+\_\+object\+\_\+method()}} \item \mbox{\hyperlink{group__object__functions_ga3f3c875b6632a9b028a5d63be30bec14}{call\+\_\+object\+\_\+method\+\_\+args()}} \end{DoxyItemize} \end{DoxySeeAlso} \mbox{\Hypertarget{group__misc__functions_ga7540367a4c8ba030499a7ad50f8b4d92}\label{group__misc__functions_ga7540367a4c8ba030499a7ad50f8b4d92}} \index{Miscellaneous Functions@{Miscellaneous Functions}!call\_function@{call\_function}} \index{call\_function@{call\_function}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{call\_function()}{call\_function()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} {\footnotesize\ttfamily auto Qore\+::call\+\_\+function (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{name, }\item[{}]{... }\end{DoxyParamCaption})} Calls a function and returns the return value, passing the remaining arguments after the function name to the function. \begin{DoxyParams}{Parameters} {\em name} & The name of the function to call \\ \hline {\em ...} & Any optional arguments to the function\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} The value returned by the called function \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{auto result = \mbox{\hyperlink{group__misc__functions_ga7540367a4c8ba030499a7ad50f8b4d92}{call\_function}}(\textcolor{stringliteral}{"{}func\_name"{}}, arg1, arg2);} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyExceptions}{Exceptions} {\em INVALID-\/\+FUNCTION-\/\+ACCESS} & Parse options do not allow access to the function \\ \hline {\em NO-\/\+FUNCTION} & The function does not exist\\ \hline \end{DoxyExceptions} \begin{DoxyNote}{Note} The function called could also throw other exceptions \end{DoxyNote} \begin{DoxySeeAlso}{See also} \begin{DoxyItemize} \item \mbox{\hyperlink{group__misc__functions_ga186059954046920e50aa418739638b8e}{call\+\_\+function\+\_\+args()}} \item \mbox{\hyperlink{group__object__functions_ga46a72b2a2a84282c5125b6fd7a2e6b23}{call\+\_\+static\+\_\+method()}} \item \mbox{\hyperlink{group__object__functions_gaf3059a3551575f93e04f2f58ae0ab4c4}{call\+\_\+static\+\_\+method\+\_\+args()}} \item \mbox{\hyperlink{group__object__functions_ga733217c233efed0557e133a6cc45189f}{call\+\_\+object\+\_\+method()}} \item \mbox{\hyperlink{group__object__functions_ga3f3c875b6632a9b028a5d63be30bec14}{call\+\_\+object\+\_\+method\+\_\+args()}} \end{DoxyItemize} \end{DoxySeeAlso} \mbox{\Hypertarget{group__misc__functions_ga85bd0d8e44d4011c85bc57fbebd99482}\label{group__misc__functions_ga85bd0d8e44d4011c85bc57fbebd99482}} \index{Miscellaneous Functions@{Miscellaneous Functions}!call\_function\_args@{call\_function\_args}} \index{call\_function\_args@{call\_function\_args}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{call\_function\_args()}{call\_function\_args()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} {\footnotesize\ttfamily auto Qore\+::call\+\_\+function\+\_\+args (\begin{DoxyParamCaption}\item[{code}]{f, }\item[{\+\_\+\+\_\+7\+\_\+ softlist$<$ auto $>$}]{vargs }\end{DoxyParamCaption})} Calls the given \mbox{\hyperlink{expressions_call_reference}{call reference}} or \mbox{\hyperlink{expressions_closure}{closure}} and returns the result, using the optional second argument as a list of arguments to the \mbox{\hyperlink{expressions_call_reference}{call reference}} or \mbox{\hyperlink{expressions_closure}{closure}}. \begin{DoxyParams}{Parameters} {\em f} & The \mbox{\hyperlink{expressions_call_reference}{call reference}} or \mbox{\hyperlink{expressions_closure}{closure}} \\ \hline {\em vargs} & Optionally a single argument to the \mbox{\hyperlink{expressions_call_reference}{call reference}} or \mbox{\hyperlink{expressions_closure}{closure}} or a list of arguments to the \mbox{\hyperlink{expressions_call_reference}{call reference}} or \mbox{\hyperlink{expressions_closure}{closure}}\\ \hline \end{DoxyParams} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{auto result = \mbox{\hyperlink{group__misc__functions_ga186059954046920e50aa418739638b8e}{call\_function\_args}}(call\_ref, (arg1, arg2));} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyNote}{Note} The \mbox{\hyperlink{expressions_call_reference}{call reference}} or \mbox{\hyperlink{expressions_closure}{closure}} called could also throw other exceptions \end{DoxyNote} \begin{DoxySeeAlso}{See also} \begin{DoxyItemize} \item \mbox{\hyperlink{group__misc__functions_ga7540367a4c8ba030499a7ad50f8b4d92}{call\+\_\+function()}} \item \mbox{\hyperlink{group__object__functions_ga46a72b2a2a84282c5125b6fd7a2e6b23}{call\+\_\+static\+\_\+method()}} \item \mbox{\hyperlink{group__object__functions_gaf3059a3551575f93e04f2f58ae0ab4c4}{call\+\_\+static\+\_\+method\+\_\+args()}} \item \mbox{\hyperlink{group__object__functions_ga733217c233efed0557e133a6cc45189f}{call\+\_\+object\+\_\+method()}} \item \mbox{\hyperlink{group__object__functions_ga3f3c875b6632a9b028a5d63be30bec14}{call\+\_\+object\+\_\+method\+\_\+args()}} \end{DoxyItemize} \end{DoxySeeAlso} \mbox{\Hypertarget{group__misc__functions_ga186059954046920e50aa418739638b8e}\label{group__misc__functions_ga186059954046920e50aa418739638b8e}} \index{Miscellaneous Functions@{Miscellaneous Functions}!call\_function\_args@{call\_function\_args}} \index{call\_function\_args@{call\_function\_args}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{call\_function\_args()}{call\_function\_args()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} {\footnotesize\ttfamily auto Qore\+::call\+\_\+function\+\_\+args (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{name, }\item[{\+\_\+\+\_\+7\+\_\+ softlist$<$ auto $>$}]{vargs }\end{DoxyParamCaption})} Calls a function and returns the return value, using the optional second argument as a list of arguments for the function. \begin{DoxyParams}{Parameters} {\em name} & The name of the function to call \\ \hline {\em vargs} & Optionally a single argument to the function or a list of arguments to the function\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} The value returned by the called function \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{auto result = \mbox{\hyperlink{group__misc__functions_ga186059954046920e50aa418739638b8e}{call\_function\_args}}(\textcolor{stringliteral}{"{}func\_name"{}}, (arg1, arg2));} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyExceptions}{Exceptions} {\em INVALID-\/\+FUNCTION-\/\+ACCESS} & Parse options do not allow access to the function \\ \hline {\em NO-\/\+FUNCTION} & The function does not exist\\ \hline \end{DoxyExceptions} \begin{DoxyNote}{Note} The function called could also throw other exceptions \end{DoxyNote} \begin{DoxySeeAlso}{See also} \begin{DoxyItemize} \item \mbox{\hyperlink{group__misc__functions_ga7540367a4c8ba030499a7ad50f8b4d92}{call\+\_\+function()}} \item \mbox{\hyperlink{group__object__functions_ga46a72b2a2a84282c5125b6fd7a2e6b23}{call\+\_\+static\+\_\+method()}} \item \mbox{\hyperlink{group__object__functions_gaf3059a3551575f93e04f2f58ae0ab4c4}{call\+\_\+static\+\_\+method\+\_\+args()}} \item \mbox{\hyperlink{group__object__functions_ga733217c233efed0557e133a6cc45189f}{call\+\_\+object\+\_\+method()}} \item \mbox{\hyperlink{group__object__functions_ga3f3c875b6632a9b028a5d63be30bec14}{call\+\_\+object\+\_\+method\+\_\+args()}} \end{DoxyItemize} \end{DoxySeeAlso} \mbox{\Hypertarget{group__misc__functions_gafd6a2b1500aca8b73c112b723695af4f}\label{group__misc__functions_gafd6a2b1500aca8b73c112b723695af4f}} \index{Miscellaneous Functions@{Miscellaneous Functions}!decode\_uri\_request@{decode\_uri\_request}} \index{decode\_uri\_request@{decode\_uri\_request}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{decode\_uri\_request()}{decode\_uri\_request()}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::decode\+\_\+uri\+\_\+request (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{uri }\end{DoxyParamCaption})} Decodes percent-\/encoded codes in a URI path and converts {\ttfamily \char`\"{}+\char`\"{}} signs in the query component to spaces and returns the decoded string in UTF-\/8 encoding. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{string decoded\_uri = \mbox{\hyperlink{group__misc__functions_gafd6a2b1500aca8b73c112b723695af4f}{decode\_uri\_request}}(\textcolor{stringliteral}{"{}path/to/something\%20else?query=1\%2b1+\%2b2"{}});} \DoxyCodeLine{\textcolor{comment}{\# results in: "{}path/to/something else?query=1+1 +2"{}}} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em uri} & a URI request string to decode\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the decoded URI request string in UTF-\/8 encoding \end{DoxyReturn} The URI string is divided into three parts\+: \begin{DoxyItemize} \item the path, which is the first part of the URI string up until any {\ttfamily \char`\"{}?\char`\"{}} or {\ttfamily \char`\"{}\#\char`\"{}} character \item the query, which is any string following a {\ttfamily \char`\"{}?\char`\"{}} character terminating the path and up to a possible {\ttfamily \char`\"{}\#\char`\"{}} character \item the fragment, which is any string following a {\ttfamily \char`\"{}\#\char`\"{}} character \end{DoxyItemize} For all parts, any percent-\/encoded codes (\href{http://tools.ietf.org/html/rfc3986\#section-2.1}{\texttt{ RFC 3986 2.\+1}}) are decoded to the corresponinding character. The path component is identified and distinguished by a {\ttfamily \char`\"{}?\char`\"{}} or a {\ttfamily \char`\"{}\#\char`\"{}} character. The path component is subjected to standard percent encoding. The query component is any part of the URI string following a {\ttfamily \char`\"{}?\char`\"{}} character up to the end of the URI string or until a {\ttfamily \char`\"{}\#\char`\"{}} characer is found. The query component is subjected to special decoding for AJAX compatibility; {\ttfamily \char`\"{}+\char`\"{}} characters are decoded to ASCII space (therefore any {\ttfamily \char`\"{}+\char`\"{}} charaters in the query component of the URI must be encoded with percent encoding, such is the case with \mbox{\hyperlink{group__misc__functions_gad0bbcfc5357d459cb538e57e85c1971e}{Qore\+::encode\+\_\+uri\+\_\+request()}} for example). The fragment component is identified as any text following a {\ttfamily \char`\"{}\#\char`\"{}} character, and this is decoded with the same rules as in the path component. \begin{DoxyNote}{Note} the difference between this function and \mbox{\hyperlink{group__misc__functions_ga51b949c2d20900fdc2e1b8e46988d2b1}{Qore\+::decode\+\_\+url()}} is that this function employs special logic in the decoding of the different components of the URI string for compatibility with common AJAX libraries that encode ASCII spaces as {\ttfamily \char`\"{}+\char`\"{}} in the query component of the URI string. \end{DoxyNote} \begin{DoxySeeAlso}{See also} \begin{DoxyItemize} \item \mbox{\hyperlink{group__misc__functions_gad0bbcfc5357d459cb538e57e85c1971e}{encode\+\_\+uri\+\_\+request()}} \item \mbox{\hyperlink{group__misc__functions_ga639fba8c278c69ac4d4190ca1db19235}{encode\+\_\+url()}} \item \mbox{\hyperlink{group__misc__functions_ga51b949c2d20900fdc2e1b8e46988d2b1}{decode\+\_\+url()}} \end{DoxyItemize} \end{DoxySeeAlso} \begin{DoxySince}{Since} Qore 0.\+8.\+12 \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_ga2f5349505d3d2563ef31f4d8b5c5f1b3}\label{group__misc__functions_ga2f5349505d3d2563ef31f4d8b5c5f1b3}} \index{Miscellaneous Functions@{Miscellaneous Functions}!decode\_url@{decode\_url}} \index{decode\_url@{decode\_url}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{decode\_url()}{decode\_url()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} {\footnotesize\ttfamily nothing Qore\+::decode\+\_\+url (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_RUNTIME_NOOP}{RUNTIME\+\_\+\+NOOP}} \end{DoxyParagraph} \mbox{\Hypertarget{group__misc__functions_ga51b949c2d20900fdc2e1b8e46988d2b1}\label{group__misc__functions_ga51b949c2d20900fdc2e1b8e46988d2b1}} \index{Miscellaneous Functions@{Miscellaneous Functions}!decode\_url@{decode\_url}} \index{decode\_url@{decode\_url}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{decode\_url()}{decode\_url()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::decode\+\_\+url (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{url }\end{DoxyParamCaption})} Decodes percent numeric codes in a URL string and returns the decoded string in UTF-\/8 encoding. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em url} & a URL string with percent-\/encodings to decode\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the URL string in UTF-\/8 encoding with all percent-\/encodings decoded \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{string decoded\_url = \mbox{\hyperlink{group__misc__functions_ga51b949c2d20900fdc2e1b8e46988d2b1}{decode\_url}}(encoded\_url);} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyNote}{Note} percent decoding is made according to \href{http://tools.ietf.org/html/rfc3986\#section-2.1}{\texttt{ RFC 3986 2.\+1}} \end{DoxyNote} \begin{DoxySeeAlso}{See also} \begin{DoxyItemize} \item \mbox{\hyperlink{group__misc__functions_ga639fba8c278c69ac4d4190ca1db19235}{encode\+\_\+url()}} \item \mbox{\hyperlink{group__misc__functions_gad0bbcfc5357d459cb538e57e85c1971e}{encode\+\_\+uri\+\_\+request()}} \item \mbox{\hyperlink{group__misc__functions_gafd6a2b1500aca8b73c112b723695af4f}{decode\+\_\+uri\+\_\+request()}} for a similar function that provides AJAX-\/compatible URI decoding for the URI query component \end{DoxyItemize} \end{DoxySeeAlso} \mbox{\Hypertarget{group__misc__functions_gad0bbcfc5357d459cb538e57e85c1971e}\label{group__misc__functions_gad0bbcfc5357d459cb538e57e85c1971e}} \index{Miscellaneous Functions@{Miscellaneous Functions}!encode\_uri\_request@{encode\_uri\_request}} \index{encode\_uri\_request@{encode\_uri\_request}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{encode\_uri\_request()}{encode\_uri\_request()}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::encode\+\_\+uri\+\_\+request (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{url }\end{DoxyParamCaption})} Encodes URI requests by substituting special characters in the path with percent-\/encoded equivalents and substituting spaces with {\ttfamily \char`\"{}+\char`\"{}} and {\ttfamily \char`\"{}+\char`\"{}} with the percent-\/encoded equivalent in the URI query component. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{string encoded\_uri = \mbox{\hyperlink{group__misc__functions_gad0bbcfc5357d459cb538e57e85c1971e}{encode\_uri\_request}}(\textcolor{stringliteral}{"{}path/to/something else?query=1+1 +2"{}})\textcolor{stringliteral}{'}} \DoxyCodeLine{\textcolor{stringliteral}{}\textcolor{comment}{\# results in: "{}path/to/something\%20else?query=1\%2b1+\%2b2"{}}} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em url} & a URL string to encode\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the URI request string with encoded according to the arguments \end{DoxyReturn} The URI string is divided into three parts\+: \begin{DoxyItemize} \item the path, which is the first part of the URI string up until any {\ttfamily \char`\"{}?\char`\"{}} or {\ttfamily \char`\"{}\#\char`\"{}} character \item the query, which is any string following a {\ttfamily \char`\"{}?\char`\"{}} character terminating the path and up to a possible {\ttfamily \char`\"{}\#\char`\"{}} character \item the fragment, which is any string following a {\ttfamily \char`\"{}\#\char`\"{}} character \end{DoxyItemize} For all parts, any non-\/\+ASCII characters and the {\ttfamily \char`\"{}\%\char`\"{}} character are subjected to percent encoding (\href{http://tools.ietf.org/html/rfc3986\#section-2.1}{\texttt{ RFC 3986 2.\+1}}). The path component is identified and distinguished by a {\ttfamily \char`\"{}?\char`\"{}} or a {\ttfamily \char`\"{}\#\char`\"{}} character. Any spaces in the path component are also subjected to percent encoding. The query component is any part of the URI string following a {\ttfamily \char`\"{}?\char`\"{}} character up to the end of the URI string or until a {\ttfamily \char`\"{}\#\char`\"{}} characer is found. Spaces in the query component are encoded with {\ttfamily \char`\"{}+\char`\"{}} for compatibility with AJAX libraries, and {\ttfamily \char`\"{}+\char`\"{}} signs are subjected to percent encoding. The fragment component is identified as any text following a {\ttfamily \char`\"{}\#\char`\"{}} character, and this is encoded with the same rules as in the path component. \begin{DoxyNote}{Note} the difference between this function and \mbox{\hyperlink{group__misc__functions_ga639fba8c278c69ac4d4190ca1db19235}{Qore\+::encode\+\_\+url()}} is that this function employs special logic in the encoding of the different components of the URI string for compatibility with common AJAX libraries that encode ASCII spaces as {\ttfamily \char`\"{}+\char`\"{}} in the query component of the URI string \end{DoxyNote} \begin{DoxySeeAlso}{See also} \begin{DoxyItemize} \item \mbox{\hyperlink{group__misc__functions_gafd6a2b1500aca8b73c112b723695af4f}{decode\+\_\+uri\+\_\+request()}} \item \mbox{\hyperlink{group__misc__functions_ga51b949c2d20900fdc2e1b8e46988d2b1}{decode\+\_\+url()}} \item \mbox{\hyperlink{group__misc__functions_ga639fba8c278c69ac4d4190ca1db19235}{encode\+\_\+url()}} \item \href{http://tools.ietf.org/html/rfc3986}{\texttt{ RFC 3986}} \item \href{http://tools.ietf.org/html/rfc6874}{\texttt{ RFC 6874}} \end{DoxyItemize} \end{DoxySeeAlso} \begin{DoxySince}{Since} Qore 0.\+8.\+12 \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_ga639fba8c278c69ac4d4190ca1db19235}\label{group__misc__functions_ga639fba8c278c69ac4d4190ca1db19235}} \index{Miscellaneous Functions@{Miscellaneous Functions}!encode\_url@{encode\_url}} \index{encode\_url@{encode\_url}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{encode\_url()}{encode\_url()}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::encode\+\_\+url (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{url, }\item[{softbool}]{encode\+\_\+all = {\ttfamily \mbox{\hyperlink{group__boolean__constants_ga9da2b9a8003cd3788e48305f8a00540f}{False}}} }\end{DoxyParamCaption})} Encodes URLs by substituting {\ttfamily \textquotesingle{}\%\textquotesingle{}} characters with {\ttfamily \textquotesingle{}\%25\textquotesingle{}}, spaces ({\ttfamily \textquotesingle{}} \textquotesingle{}) with {\ttfamily \textquotesingle{}\%20\textquotesingle{}}, and non-\/ascii characters by percent-\/encoded representations. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em url} & a URL string to encode \\ \hline {\em encode\+\_\+all} & if \mbox{\hyperlink{basic_data_types_True}{True}}, then in addition to {\ttfamily \textquotesingle{}\%\textquotesingle{}}, spaces ({\ttfamily \textquotesingle{}} \textquotesingle{}), and non-\/ascii characters the following reserved characters (according to \href{http://tools.ietf.org/html/rfc3986}{\texttt{ RFC 3986}} are also encoded\+: {\ttfamily \textquotesingle{}!\textquotesingle{}}, {\ttfamily \textquotesingle{}$\ast$\textquotesingle{}}, {\ttfamily \textquotesingle{}\textbackslash{}\textquotesingle{}\textquotesingle{}}, {\ttfamily \textquotesingle{}}(\textquotesingle{}, {\ttfamily \textquotesingle{}})\textquotesingle{}, {\ttfamily \textquotesingle{}};\textquotesingle{}, {\ttfamily \textquotesingle{}}\+:\textquotesingle{}, {\ttfamily \textquotesingle{}@\textquotesingle{}}, {\ttfamily \textquotesingle{}\&\textquotesingle{}}, {\ttfamily \textquotesingle{}=\textquotesingle{}}, {\ttfamily \textquotesingle{}+\textquotesingle{}}, {\ttfamily \textquotesingle{}\$\textquotesingle{}}, {\ttfamily \textquotesingle{}},\textquotesingle{}, {\ttfamily \textquotesingle{}/\textquotesingle{}}, {\ttfamily \textquotesingle{}}?\textquotesingle{}, {\ttfamily \textquotesingle{}\#\textquotesingle{}}, {\ttfamily \textquotesingle{}}\mbox{[}\textquotesingle{}, {\ttfamily \textquotesingle{}}\mbox{]}\textquotesingle{}\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the URL string with encoded according to the arguments \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{string encoded\_url = \mbox{\hyperlink{group__misc__functions_ga639fba8c278c69ac4d4190ca1db19235}{encode\_url}}(url);} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxySeeAlso}{See also} \begin{DoxyItemize} \item \mbox{\hyperlink{group__misc__functions_ga51b949c2d20900fdc2e1b8e46988d2b1}{decode\+\_\+url()}} \item \mbox{\hyperlink{group__misc__functions_gad0bbcfc5357d459cb538e57e85c1971e}{encode\+\_\+uri\+\_\+request()}} for a similar function that provides AJAX-\/compatible URI encoding for the URI query component \item \mbox{\hyperlink{group__misc__functions_gafd6a2b1500aca8b73c112b723695af4f}{decode\+\_\+uri\+\_\+request()}} \end{DoxyItemize} \end{DoxySeeAlso} \begin{DoxySince}{Since} Qore 0.\+8.\+9 \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_gad1e87cdb4aded090b1801d952e018a50}\label{group__misc__functions_gad1e87cdb4aded090b1801d952e018a50}} \index{Miscellaneous Functions@{Miscellaneous Functions}!exists@{exists}} \index{exists@{exists}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{exists()}{exists()}} {\footnotesize\ttfamily bool Qore\+::exists (\begin{DoxyParamCaption}\item[{}]{... }\end{DoxyParamCaption})} A function performing the same role as the \mbox{\hyperlink{operators_exists}{exists operator}}. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em ...} & if only a single argument is passed, then this function returns \mbox{\hyperlink{basic_data_types_True}{True}} if the single argument exists, \mbox{\hyperlink{basic_data_types_False}{False}} if not; otherwise is multiple arguments are passed to the function, it always returns \mbox{\hyperlink{basic_data_types_True}{True}}; this is to emulate the behavior of the \mbox{\hyperlink{operators_exists}{exists operator}}\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} if only a single argument is passed, then this function returns \mbox{\hyperlink{basic_data_types_True}{True}} if the single argument exists, \mbox{\hyperlink{basic_data_types_False}{False}} if not; otherwise is multiple arguments are passed to the function, it always returns \mbox{\hyperlink{basic_data_types_True}{True}}; this is to emulate the behavior of the \mbox{\hyperlink{operators_exists}{exists operator}} \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{bool b = \mbox{\hyperlink{group__misc__functions_gad1e87cdb4aded090b1801d952e018a50}{exists}}(val);} \end{DoxyCode} \end{DoxyParagraph} \mbox{\Hypertarget{group__misc__functions_gad985bd6dcc2a74fd36c087881d21b40c}\label{group__misc__functions_gad985bd6dcc2a74fd36c087881d21b40c}} \index{Miscellaneous Functions@{Miscellaneous Functions}!exists\_function@{exists\_function}} \index{exists\_function@{exists\_function}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{exists\_function()}{exists\_function()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} {\footnotesize\ttfamily bool Qore\+::exists\+\_\+function (\begin{DoxyParamCaption}\item[{code}]{c }\end{DoxyParamCaption})} Always returns \mbox{\hyperlink{basic_data_types_True}{True}}. This function variant is included for backwards-\/compatibility \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_NOOP}{NOOP}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em c} & a \mbox{\hyperlink{expressions_call_reference}{call reference}} or \mbox{\hyperlink{expressions_closure}{closure}}\+:\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} always returns \mbox{\hyperlink{basic_data_types_True}{True}} \end{DoxyReturn} \begin{DoxySince}{Since} Qore 0.\+8.\+12 as a replacement for deprecated camel-\/case \mbox{\hyperlink{group__misc__functions_ga83615e15094fca9ffe868ee0d80cd002}{exists\+Function()}} \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_ga3a1dcf3c8f3908896ca2aabfcc41010c}\label{group__misc__functions_ga3a1dcf3c8f3908896ca2aabfcc41010c}} \index{Miscellaneous Functions@{Miscellaneous Functions}!exists\_function@{exists\_function}} \index{exists\_function@{exists\_function}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{exists\_function()}{exists\_function()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} {\footnotesize\ttfamily bool Qore\+::exists\+\_\+function (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{name }\end{DoxyParamCaption})} Returns \mbox{\hyperlink{basic_data_types_True}{True}} if the function exists in the current program\textquotesingle{}s function name space. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em name} & the name of the function to check\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} \mbox{\hyperlink{basic_data_types_True}{True}} if the function exists in the current program\textquotesingle{}s function name space, \mbox{\hyperlink{basic_data_types_False}{False}} if not \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{bool b = \mbox{\hyperlink{group__misc__functions_ga3a1dcf3c8f3908896ca2aabfcc41010c}{exists\_function}}(\textcolor{stringliteral}{"{}func\_name"{}});} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxySince}{Since} Qore 0.\+8.\+12 as a replacement for deprecated camel-\/case \mbox{\hyperlink{group__misc__functions_ga83615e15094fca9ffe868ee0d80cd002}{exists\+Function()}} \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_gac6b3861f291cf4c2f62742fc8ec9b717}\label{group__misc__functions_gac6b3861f291cf4c2f62742fc8ec9b717}} \index{Miscellaneous Functions@{Miscellaneous Functions}!existsFunction@{existsFunction}} \index{existsFunction@{existsFunction}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{existsFunction()}{existsFunction()}\hspace{0.1cm}{\footnotesize\ttfamily [1/3]}} {\footnotesize\ttfamily nothing Qore\+::exists\+Function (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_RUNTIME_NOOP}{RUNTIME\+\_\+\+NOOP}}, \mbox{\hyperlink{code_flags_DEPRECATED}{DEPRECATED}} \end{DoxyParagraph} \mbox{\Hypertarget{group__misc__functions_gaa3aa518a4c17e2593c2773bc6b71af3c}\label{group__misc__functions_gaa3aa518a4c17e2593c2773bc6b71af3c}} \index{Miscellaneous Functions@{Miscellaneous Functions}!existsFunction@{existsFunction}} \index{existsFunction@{existsFunction}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{existsFunction()}{existsFunction()}\hspace{0.1cm}{\footnotesize\ttfamily [2/3]}} {\footnotesize\ttfamily bool Qore\+::exists\+Function (\begin{DoxyParamCaption}\item[{code}]{c }\end{DoxyParamCaption})} Always returns \mbox{\hyperlink{basic_data_types_True}{True}}. This function variant is included for backwards-\/compatibility \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_NOOP}{NOOP}}, \mbox{\hyperlink{code_flags_DEPRECATED}{DEPRECATED}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em c} & a \mbox{\hyperlink{expressions_call_reference}{call reference}} or \mbox{\hyperlink{expressions_closure}{closure}}\+:\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} always returns \mbox{\hyperlink{basic_data_types_True}{True}} \end{DoxyReturn} \begin{DoxyRefDesc}{Deprecated} \item[\mbox{\hyperlink{deprecated__deprecated000016}{Deprecated}}]use \mbox{\hyperlink{group__misc__functions_ga3a1dcf3c8f3908896ca2aabfcc41010c}{exists\+\_\+function()}}; camel-\/case function names were deprecated in Qore 0.\+8.\+12 \end{DoxyRefDesc} \mbox{\Hypertarget{group__misc__functions_ga83615e15094fca9ffe868ee0d80cd002}\label{group__misc__functions_ga83615e15094fca9ffe868ee0d80cd002}} \index{Miscellaneous Functions@{Miscellaneous Functions}!existsFunction@{existsFunction}} \index{existsFunction@{existsFunction}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{existsFunction()}{existsFunction()}\hspace{0.1cm}{\footnotesize\ttfamily [3/3]}} {\footnotesize\ttfamily bool Qore\+::exists\+Function (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{name }\end{DoxyParamCaption})} Returns \mbox{\hyperlink{basic_data_types_True}{True}} if the function exists in the current program\textquotesingle{}s function name space. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}}, \mbox{\hyperlink{code_flags_DEPRECATED}{DEPRECATED}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em name} & the name of the function to check\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} \mbox{\hyperlink{basic_data_types_True}{True}} if the function exists in the current program\textquotesingle{}s function name space, \mbox{\hyperlink{basic_data_types_False}{False}} if not \end{DoxyReturn} \begin{DoxyRefDesc}{Deprecated} \item[\mbox{\hyperlink{deprecated__deprecated000015}{Deprecated}}]use \mbox{\hyperlink{group__misc__functions_ga3a1dcf3c8f3908896ca2aabfcc41010c}{exists\+\_\+function()}}; camel-\/case function names were deprecated in Qore 0.\+8.\+12 \end{DoxyRefDesc} \mbox{\Hypertarget{group__misc__functions_ga23f1e7651ff70e32e9ba7c28907b1306}\label{group__misc__functions_ga23f1e7651ff70e32e9ba7c28907b1306}} \index{Miscellaneous Functions@{Miscellaneous Functions}!function\_type@{function\_type}} \index{function\_type@{function\_type}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{function\_type()}{function\_type()}} {\footnotesize\ttfamily \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::function\+\_\+type (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{name }\end{DoxyParamCaption})} Returns {\ttfamily \char`\"{}builtin\char`\"{}} (for a builtin function), {\ttfamily \char`\"{}user\char`\"{}} (for a user function), or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} (if the function cannot be found) according to the function name passed. \begin{DoxyParams}{Parameters} {\em name} & The function name to check \\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} {\ttfamily \char`\"{}builtin\char`\"{}} (for a builtin function), {\ttfamily \char`\"{}user\char`\"{}} (for a user function), or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} (if the function cannot be found) according to the function name passed \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{*string type = \mbox{\hyperlink{group__misc__functions_ga23f1e7651ff70e32e9ba7c28907b1306}{function\_type}}(\textcolor{stringliteral}{"{}print"{}});} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxySince}{Since} Qore 0.\+8.\+12 as a replacement for deprecated camel-\/case \mbox{\hyperlink{group__misc__functions_ga5ae2be041abe7d02be8a2ccc67c0032f}{function\+Type()}} \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_gaf46dfa4dc44e9e7091e981c87ebbe438}\label{group__misc__functions_gaf46dfa4dc44e9e7091e981c87ebbe438}} \index{Miscellaneous Functions@{Miscellaneous Functions}!functionType@{functionType}} \index{functionType@{functionType}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{functionType()}{functionType()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} {\footnotesize\ttfamily nothing Qore\+::function\+Type (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_RUNTIME_NOOP}{RUNTIME\+\_\+\+NOOP}}, \mbox{\hyperlink{code_flags_DEPRECATED}{DEPRECATED}} \end{DoxyParagraph} \mbox{\Hypertarget{group__misc__functions_ga5ae2be041abe7d02be8a2ccc67c0032f}\label{group__misc__functions_ga5ae2be041abe7d02be8a2ccc67c0032f}} \index{Miscellaneous Functions@{Miscellaneous Functions}!functionType@{functionType}} \index{functionType@{functionType}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{functionType()}{functionType()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} {\footnotesize\ttfamily \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::function\+Type (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{name }\end{DoxyParamCaption})} Returns {\ttfamily \char`\"{}builtin\char`\"{}} (for a builtin function), {\ttfamily \char`\"{}user\char`\"{}} (for a user function), or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} (if the function cannot be found) according to the function name passed. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}}, \mbox{\hyperlink{code_flags_DEPRECATED}{DEPRECATED}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em name} & The function name to check \\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} {\ttfamily \char`\"{}builtin\char`\"{}} (for a builtin function), {\ttfamily \char`\"{}user\char`\"{}} (for a user function), or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} (if the function cannot be found) according to the function name passed \end{DoxyReturn} \begin{DoxyRefDesc}{Deprecated} \item[\mbox{\hyperlink{deprecated__deprecated000017}{Deprecated}}]use \mbox{\hyperlink{group__misc__functions_ga23f1e7651ff70e32e9ba7c28907b1306}{function\+\_\+type()}}; camel-\/case function names were deprecated in Qore 0.\+8.\+12 \end{DoxyRefDesc} \mbox{\Hypertarget{group__misc__functions_ga8a7ea9de612741d9bb26bf926d211c71}\label{group__misc__functions_ga8a7ea9de612741d9bb26bf926d211c71}} \index{Miscellaneous Functions@{Miscellaneous Functions}!get\_byte@{get\_byte}} \index{get\_byte@{get\_byte}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{get\_byte()}{get\_byte()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} {\footnotesize\ttfamily \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} Qore\+::get\+\_\+byte (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}}}]{b, }\item[{softint}]{offset = {\ttfamily 0} }\end{DoxyParamCaption})} Returns the byte value at the given byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em b} & the data to process \\ \hline {\em offset} & the byte offset of the data to retrieve (the first value is at offset 0)\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the byte value at the given byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{*int byte = \mbox{\hyperlink{group__misc__functions_ga24aed47f45573187b6644d5ec1a3aeb5}{get\_byte}}(bin, 2); \textcolor{comment}{\# returns the third byte of the binary object}} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyNote}{Note} this function is equivalent to the more efficient \mbox{\hyperlink{operators_list_element_operator}{\mbox{[}\mbox{]} operator}} when used with a binary argument~\newline ~\newline Furthermore this function is identical to \mbox{\hyperlink{group__misc__functions_ga3a6b906bee63eb28d20610da64fd5417}{get\+Byte()}}, except this function has no \mbox{\hyperlink{code_flags_RUNTIME_NOOP}{RUNTIME\+\_\+\+NOOP}} variant \end{DoxyNote} \mbox{\Hypertarget{group__misc__functions_ga24aed47f45573187b6644d5ec1a3aeb5}\label{group__misc__functions_ga24aed47f45573187b6644d5ec1a3aeb5}} \index{Miscellaneous Functions@{Miscellaneous Functions}!get\_byte@{get\_byte}} \index{get\_byte@{get\_byte}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{get\_byte()}{get\_byte()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} {\footnotesize\ttfamily \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} Qore\+::get\+\_\+byte (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{str, }\item[{softint}]{offset = {\ttfamily 0} }\end{DoxyParamCaption})} Returns the byte value at the given byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em str} & the string data to process \\ \hline {\em offset} & the byte offset of the data to retrieve (the first value is at offset 0)\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the byte value at the given byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{*int byte = \mbox{\hyperlink{group__misc__functions_ga24aed47f45573187b6644d5ec1a3aeb5}{get\_byte}}(str, 2); \textcolor{comment}{\# returns the third byte of the string}} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyNote}{Note} that for strings this function is not equivalent to the \mbox{\hyperlink{operators_list_element_operator}{\mbox{[}\mbox{]} operator}} for multi-\/byte character encodings, as this function works purely on bytes and the \mbox{\hyperlink{operators_list_element_operator}{\mbox{[}\mbox{]} operator}} operates on characters~\newline ~\newline Furthermore this function is identical to \mbox{\hyperlink{group__misc__functions_ga3a6b906bee63eb28d20610da64fd5417}{get\+Byte()}}, except this function has no \mbox{\hyperlink{code_flags_RUNTIME_NOOP}{RUNTIME\+\_\+\+NOOP}} variant \end{DoxyNote} \mbox{\Hypertarget{group__misc__functions_ga6b730c0585f1fe62929d6877c32ee0c7}\label{group__misc__functions_ga6b730c0585f1fe62929d6877c32ee0c7}} \index{Miscellaneous Functions@{Miscellaneous Functions}!get\_call\_reference@{get\_call\_reference}} \index{get\_call\_reference@{get\_call\_reference}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{get\_call\_reference()}{get\_call\_reference()}} {\footnotesize\ttfamily code Qore\+::get\+\_\+call\+\_\+reference (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{identifier }\end{DoxyParamCaption})} resolve the string as a call reference \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_RET_VALUE_ONLY}{RET\+\_\+\+VALUE\+\_\+\+ONLY}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em identifier} & the string to resolve; function or static class method, can include namespace path\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the call reference to the given function or static method; the string is resolved as follows\+: \begin{DoxyItemize} \item if in a class method, a non-\/static method lookup is made \item if not found, then a static method lookup is made \item if not found, then a function lookup is made \item if not found, an {\ttfamily CALL-\/\+REFERENCE-\/\+ERROR} exception is thrown \end{DoxyItemize} \end{DoxyReturn} \begin{DoxyExceptions}{Exceptions} {\em CALL-\/\+REFERENCE-\/\+ERROR} & cannot resolve call reference; method not accessible in the calling context\\ \hline \end{DoxyExceptions} \begin{DoxyNote}{Note} \begin{DoxyItemize} \item use \mbox{\hyperlink{class_qore_1_1zzz8objectzzz9_a1d67fa79b6676b3dcb9eaf088bbb2d4e}{Qore\+::zzz8objectzzz9\+::get\+Call\+Reference()}} to get call references to non-\/public class methods; this builtin function will always run without any class context, however pseudo-\/methods run with the class context of the caller, which enables it to access any accessible private method \item call references to non-\/static methods contain a weak reference to the object; the lifetime of the object is not extended by the call reference \end{DoxyItemize} \end{DoxyNote} \begin{DoxySeeAlso}{See also} \begin{DoxyItemize} \item \mbox{\hyperlink{class_qore_1_1zzz8objectzzz9_a1d67fa79b6676b3dcb9eaf088bbb2d4e}{Qore\+::zzz8objectzzz9\+::get\+Call\+Reference()}} \item \mbox{\hyperlink{class_qore_1_1_program_aea73d2c2b293387b51fbb5de782b7a7c}{Qore\+::\+Program\+::get\+Call\+Reference()}} \end{DoxyItemize} \end{DoxySeeAlso} \begin{DoxySince}{Since} Qore 0.\+9.\+4 \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_gaa9a0d3f277ef8cbdc99fe146dd3db49b}\label{group__misc__functions_gaa9a0d3f277ef8cbdc99fe146dd3db49b}} \index{Miscellaneous Functions@{Miscellaneous Functions}!get\_class\_name@{get\_class\_name}} \index{get\_class\_name@{get\_class\_name}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{get\_class\_name()}{get\_class\_name()}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::get\+\_\+class\+\_\+name (\begin{DoxyParamCaption}\item[{object}]{obj }\end{DoxyParamCaption})} Returns the class name of the object passed. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em obj} & the object to get the class name of \\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the class name of the object passed \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{string name = \mbox{\hyperlink{group__misc__functions_gaa9a0d3f277ef8cbdc99fe146dd3db49b}{get\_class\_name}}(obj);} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyNote}{Note} equivalent to \mbox{\hyperlink{class_qore_1_1zzz8objectzzz9_a284be71278d0b081544ba675a3d1ead5}{Qore\+::zzz8objectzzz9\+::class\+Name()}} \end{DoxyNote} \begin{DoxySince}{Since} Qore 0.\+8.\+12 as a replacement for deprecated camel-\/case \mbox{\hyperlink{group__misc__functions_ga46b9c2df48897cb68e765cb6d66728ac}{get\+Class\+Name()}} \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_ga8f800bec17c55a15ec7255dedfa25c6d}\label{group__misc__functions_ga8f800bec17c55a15ec7255dedfa25c6d}} \index{Miscellaneous Functions@{Miscellaneous Functions}!get\_default\_encoding@{get\_default\_encoding}} \index{get\_default\_encoding@{get\_default\_encoding}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{get\_default\_encoding()}{get\_default\_encoding()}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::get\+\_\+default\+\_\+encoding (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} Returns the name of the \mbox{\hyperlink{character_encoding_default_encoding}{default character encoding}}. \begin{DoxyReturn}{Returns} the name of the \mbox{\hyperlink{character_encoding_default_encoding}{default character encoding}} \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{string encoding = \mbox{\hyperlink{group__misc__functions_ga8f800bec17c55a15ec7255dedfa25c6d}{get\_default\_encoding}}();} \end{DoxyCode} \end{DoxyParagraph} \mbox{\Hypertarget{group__misc__functions_gaaa60e9a984c59e662b2e7cac84a3899d}\label{group__misc__functions_gaaa60e9a984c59e662b2e7cac84a3899d}} \index{Miscellaneous Functions@{Miscellaneous Functions}!get\_ex\_pos@{get\_ex\_pos}} \index{get\_ex\_pos@{get\_ex\_pos}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{get\_ex\_pos()}{get\_ex\_pos()}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::get\+\_\+ex\+\_\+pos (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$ auto $>$}]{ex }\end{DoxyParamCaption})} returns a descriptive string for an exception location; the {\ttfamily source} and {\ttfamily offset} information will also be included in the string returned if present in the \mbox{\hyperlink{struct_qore_1_1_exception_info}{Exception\+Info}} hash argument \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{\textcolor{keywordflow}{try} \{} \DoxyCodeLine{ throw \textcolor{stringliteral}{"{}oops"{}}, \mbox{\hyperlink{group__string__functions_ga7a74be141f814ef286046c367b21091c}{sprintf}}(\textcolor{stringliteral}{"{}arg \%y is invalid"{}}, arg);} \DoxyCodeLine{\} catch (hash ex) \{} \DoxyCodeLine{ log(\textcolor{stringliteral}{"{}\%s: \%s: \%s"{}}, \mbox{\hyperlink{group__misc__functions_gaaa60e9a984c59e662b2e7cac84a3899d}{get\_ex\_pos}}(ex), ex.err, ex.desc);} \DoxyCodeLine{\}} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em ex} & a hash which should be an \mbox{\hyperlink{struct_qore_1_1_exception_info}{Exception\+Info}} hash\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} a string describing the exception location (ex\+: {\ttfamily \char`\"{}sftp-\/poller.\+q\+:140\char`\"{}}) \end{DoxyReturn} \begin{DoxySince}{Since} Qore 0.\+8.\+7 \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_ga86de08439e084c19460ae57d3d6269e5}\label{group__misc__functions_ga86de08439e084c19460ae57d3d6269e5}} \index{Miscellaneous Functions@{Miscellaneous Functions}!get\_feature\_list@{get\_feature\_list}} \index{get\_feature\_list@{get\_feature\_list}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{get\_feature\_list()}{get\_feature\_list()}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_ga4b52a1cbee7a3aed46c32cb0a938629c}{list}}$<$\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}$>$ Qore\+::get\+\_\+feature\+\_\+list (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} Returns a list of strings of the builtin and module-\/supplied features of \mbox{\hyperlink{namespace_qore}{Qore}}. \begin{DoxyReturn}{Returns} a list of strings of the builtin and module-\/supplied features of \mbox{\hyperlink{namespace_qore}{Qore}} \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{list l = \mbox{\hyperlink{group__misc__functions_ga86de08439e084c19460ae57d3d6269e5}{get\_feature\_list}}();} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyNote}{Note} this function is not flagged with \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} since its value could change at runtime \end{DoxyNote} \begin{DoxySince}{Since} Qore 0.\+8.\+12 as a replacement for deprecated camel-\/case \mbox{\hyperlink{group__misc__functions_ga82a9721ba77a2a344b0e356d45c5a37f}{get\+Feature\+List()}} \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_ga35f238f6343017d7e4736cd2c3007752}\label{group__misc__functions_ga35f238f6343017d7e4736cd2c3007752}} \index{Miscellaneous Functions@{Miscellaneous Functions}!get\_global\_vars@{get\_global\_vars}} \index{get\_global\_vars@{get\_global\_vars}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{get\_global\_vars()}{get\_global\_vars()}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$auto$>$ Qore\+::get\+\_\+global\+\_\+vars (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} returns a hash of global variables \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{hash h = \mbox{\hyperlink{group__misc__functions_ga35f238f6343017d7e4736cd2c3007752}{get\_global\_vars}}();} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyReturn}{Returns} a hash of global variables and their values \end{DoxyReturn} \begin{DoxySeeAlso}{See also} \mbox{\hyperlink{class_qore_1_1_program_af850abe615e1fac34dae8e4fc9efc1f2}{Qore\+::\+Program\+::get\+Global\+Vars()}} \end{DoxySeeAlso} \begin{DoxySince}{Since} Qore 0.\+8.\+13 \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_gac3c60c8fa6766bc3e6809468acca8465}\label{group__misc__functions_gac3c60c8fa6766bc3e6809468acca8465}} \index{Miscellaneous Functions@{Miscellaneous Functions}!get\_local\_vars@{get\_local\_vars}} \index{get\_local\_vars@{get\_local\_vars}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{get\_local\_vars()}{get\_local\_vars()}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$auto$>$ Qore\+::get\+\_\+local\+\_\+vars (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}}}]{frame }\end{DoxyParamCaption})} retrieves a hash of local variables for the given stack frame \begin{DoxyParagraph}{Restrictions\+:} MUST HAVE\+: \mbox{\hyperlink{group__parse__options_gad0d38cd46f08bf4210d4010204269cc9}{Qore\+::\+PO\+\_\+\+ALLOW\+\_\+\+DEBUGGER}} \end{DoxyParagraph} \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_RET_VALUE_ONLY}{RET\+\_\+\+VALUE\+\_\+\+ONLY}} \end{DoxyParagraph} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{hash h = \mbox{\hyperlink{group__misc__functions_gac3c60c8fa6766bc3e6809468acca8465}{get\_local\_vars}}(0);} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em frame} & the stack frame where 0 is the current stack frame\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} a hash of local variables for the given stack frame; if the stack frame is invalid, an empty hash is returned; hash keys are variable names; hash values are hashes with the following keys\+: \begin{DoxyItemize} \item {\ttfamily \char`\"{}type\char`\"{}}\+: can be either \char`\"{}local\char`\"{} or \char`\"{}closure\char`\"{} for closure-\/bound local variables \item {\ttfamily \char`\"{}value\char`\"{}}\+: the value of the variable \end{DoxyItemize} \end{DoxyReturn} \begin{DoxyExceptions}{Exceptions} {\em CIRCULAR-\/\+REFERENCE-\/\+ERROR} & circular reference found when retrieving local variable values\\ \hline \end{DoxyExceptions} \begin{DoxySince}{Since} Qore 0.\+8.\+13 \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_gab64b871ddf6f09568d4a0798c0ca755a}\label{group__misc__functions_gab64b871ddf6f09568d4a0798c0ca755a}} \index{Miscellaneous Functions@{Miscellaneous Functions}!get\_module\_hash@{get\_module\_hash}} \index{get\_module\_hash@{get\_module\_hash}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{get\_module\_hash()}{get\_module\_hash()}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}},\mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$auto$>$ $>$ Qore\+::get\+\_\+module\+\_\+hash (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} Returns a hash of hashes describing the currently-\/loaded Qore modules; the top-\/level hash keys are the module names. \begin{DoxyReturn}{Returns} a hash of hashes describing the currently-\/loaded Qore modules; the top-\/level hash keys are the module names; the values are hashes with the following keys\+: \begin{DoxyItemize} \item {\ttfamily filename\+:} the path to the module \item {\ttfamily name\+:} the name of the module \item {\ttfamily desc\+:} the description of the module \item {\ttfamily version\+:} the version of the module \item {\ttfamily author\+:} the author of the module \item {\ttfamily api\+\_\+major\+:} the major number of the Qore module API version the module support \item {\ttfamily api\+\_\+minor\+:} the minor number of the Qore module API version the module support \item {\ttfamily url\+:} the module\textquotesingle{}s URL \item {\ttfamily license\+:} the module\textquotesingle{}s license \end{DoxyItemize} \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{hash> mh = \mbox{\hyperlink{group__misc__functions_gab64b871ddf6f09568d4a0798c0ca755a}{get\_module\_hash}}();} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyNote}{Note} this function is not flagged with \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} since its value could change at runtime \end{DoxyNote} \begin{DoxySince}{Since} Qore 0.\+8.\+12 as a replacement for deprecated camel-\/case \mbox{\hyperlink{group__misc__functions_ga34248adafed4b00da2a526f8f23017cf}{get\+Module\+Hash()}} \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_ga18cc840553c5850216308dbefa9d5a78}\label{group__misc__functions_ga18cc840553c5850216308dbefa9d5a78}} \index{Miscellaneous Functions@{Miscellaneous Functions}!get\_module\_list@{get\_module\_list}} \index{get\_module\_list@{get\_module\_list}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{get\_module\_list()}{get\_module\_list()}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_ga4b52a1cbee7a3aed46c32cb0a938629c}{list}}$<$\mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$auto$>$ $>$ Qore\+::get\+\_\+module\+\_\+list (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} Returns a list of hashes describing the currently-\/loaded Qore modules. \begin{DoxyReturn}{Returns} a list of hashes describing the currently-\/loaded Qore modules; each element in the list is a hash with the following keys\+: \begin{DoxyItemize} \item {\ttfamily filename\+:} the path to the module \item {\ttfamily name\+:} the name of the module \item {\ttfamily desc\+:} the description of the module \item {\ttfamily version\+:} the version of the module \item {\ttfamily author\+:} the author of the module \item {\ttfamily api\+\_\+major\+:} the major number of the Qore module API version the module support \item {\ttfamily api\+\_\+minor\+:} the minor number of the Qore module API version the module support \item {\ttfamily url\+:} the module\textquotesingle{}s URL \item {\ttfamily license\+:} the module\textquotesingle{}s license \end{DoxyItemize} \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{list> l = \mbox{\hyperlink{group__misc__functions_ga18cc840553c5850216308dbefa9d5a78}{get\_module\_list}}();} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyNote}{Note} this function is not flagged with \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} since its value could change at runtime \end{DoxyNote} \begin{DoxySeeAlso}{See also} \mbox{\hyperlink{group__misc__functions_gab64b871ddf6f09568d4a0798c0ca755a}{get\+\_\+module\+\_\+hash()}} \end{DoxySeeAlso} \begin{DoxySince}{Since} Qore 0.\+8.\+12 as a replacement for deprecated camel-\/case \mbox{\hyperlink{group__misc__functions_ga82506074037fe39372ea4f44e2582a75}{get\+Module\+List()}} \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_ga26bb5a87af0e8be0e661a590fb722c83}\label{group__misc__functions_ga26bb5a87af0e8be0e661a590fb722c83}} \index{Miscellaneous Functions@{Miscellaneous Functions}!get\_module\_option@{get\_module\_option}} \index{get\_module\_option@{get\_module\_option}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{get\_module\_option()}{get\_module\_option()}} {\footnotesize\ttfamily auto Qore\+::get\+\_\+module\+\_\+option (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{module, }\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{option }\end{DoxyParamCaption})} returns the given global module option \begin{DoxyParagraph}{Restrictions\+:} \mbox{\hyperlink{group__parse__options_ga10d8e3f76c427b0f974529de572dd0ec}{Qore\+::\+PO\+\_\+\+NO\+\_\+\+PROCESS\+\_\+\+CONTROL}} \end{DoxyParagraph} \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{\textcolor{keyword}{auto} val = \mbox{\hyperlink{group__misc__functions_ga26bb5a87af0e8be0e661a590fb722c83}{get\_module\_option}}(mod, opt);} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em module} & the name of the module \\ \hline {\em option} & the name of the option\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the value of the given module option \end{DoxyReturn} \begin{DoxySeeAlso}{See also} \mbox{\hyperlink{group__misc__functions_ga9034376bb44beb761d76156600b537f8}{set\+\_\+module\+\_\+option()}} \end{DoxySeeAlso} \begin{DoxySince}{Since} Qore 0.\+9 \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_ga6b1422bc842cbf53cf2bb53ef9322209}\label{group__misc__functions_ga6b1422bc842cbf53cf2bb53ef9322209}} \index{Miscellaneous Functions@{Miscellaneous Functions}!get\_parse\_options@{get\_parse\_options}} \index{get\_parse\_options@{get\_parse\_options}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{get\_parse\_options()}{get\_parse\_options()}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} Qore\+::get\+\_\+parse\+\_\+options (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} returns the current \mbox{\hyperlink{group__parse__options}{parse options}} for the current \mbox{\hyperlink{class_qore_1_1_program}{Program}} object \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{int i = \mbox{\hyperlink{group__misc__functions_ga6b1422bc842cbf53cf2bb53ef9322209}{get\_parse\_options}}();} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyReturn}{Returns} the current \mbox{\hyperlink{group__parse__options}{parse options}} for the current \mbox{\hyperlink{class_qore_1_1_program}{Program}} object \end{DoxyReturn} \begin{DoxySince}{Since} Qore 0.\+8.\+7 \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_gaa0c7ff8f74f88213fdcee6fd6082b16d}\label{group__misc__functions_gaa0c7ff8f74f88213fdcee6fd6082b16d}} \index{Miscellaneous Functions@{Miscellaneous Functions}!get\_qore\_library\_info@{get\_qore\_library\_info}} \index{get\_qore\_library\_info@{get\_qore\_library\_info}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{get\_qore\_library\_info()}{get\_qore\_library\_info()}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$auto$>$ Qore\+::get\+\_\+qore\+\_\+library\+\_\+info (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} Returns a hash of library build and version info. \begin{DoxyReturn}{Returns} a hash of library build and version info with the following keys\+: \begin{DoxyItemize} \item {\ttfamily Platform\+OS\+:} The operating system used to build the Qore library \item {\ttfamily Platform\+CPU\+:} The CPU used as a target for the Qore library build \item {\ttfamily Version\+String\+:} The full version string for this version of the Qore library \item {\ttfamily Version\+Major\+:} An integer giving the Qore library\textquotesingle{}s major version number \item {\ttfamily Version\+Minor\+:} An integer giving the Qore library\textquotesingle{}s minor version number \item {\ttfamily Version\+Sub\+:} An integer giving the Qore library\textquotesingle{}s release version number \item {\ttfamily Build\+:} An integer giving the Qore library\textquotesingle{}s subversion revision number \item {\ttfamily Build\+Host\+:} A string giving information about the host used to compile the Qore library \item {\ttfamily Compiler\+:} The compiler used to build the Qore library \item {\ttfamily Module\+Dir\+:} The module directory assumed by default in the Qore library \item {\ttfamily CFLAGS\+:} The compiler flags used to compile the Qore library \item {\ttfamily LDFLAGS\+:} The linker flags used to link the Qore library \end{DoxyItemize} \end{DoxyReturn} \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{hash h = \mbox{\hyperlink{group__misc__functions_gaa0c7ff8f74f88213fdcee6fd6082b16d}{get\_qore\_library\_info}}();} \end{DoxyCode} \end{DoxyParagraph} \mbox{\Hypertarget{group__misc__functions_ga1fe51f94becc8165b08426434fe4f138}\label{group__misc__functions_ga1fe51f94becc8165b08426434fe4f138}} \index{Miscellaneous Functions@{Miscellaneous Functions}!get\_qore\_option\_hash@{get\_qore\_option\_hash}} \index{get\_qore\_option\_hash@{get\_qore\_option\_hash}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{get\_qore\_option\_hash()}{get\_qore\_option\_hash()}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}},\mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$auto$>$ $>$ Qore\+::get\+\_\+qore\+\_\+option\+\_\+hash (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} Returns a hash of hashes giving information about Qore library options for the current build. \begin{DoxyReturn}{Returns} a hash of hashes giving information about Qore library options for the current build; the hash keys are the constant names and the values are hashes with the following keys\+: \begin{DoxyItemize} \item {\ttfamily option\+:} The string description of the option \item {\ttfamily constant\+:} A string giving the name of the constant that has the boolean value for this option (equal to the hash key name) \item {\ttfamily type\+:} The type of option \item {\ttfamily value\+:} The boolean value of the option \end{DoxyItemize} \end{DoxyReturn} \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{hash> h = \mbox{\hyperlink{group__misc__functions_ga1fe51f94becc8165b08426434fe4f138}{get\_qore\_option\_hash}}();} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxySeeAlso}{See also} \mbox{\hyperlink{group__misc__functions_ga8ed2c5a0ee827317e265808c8f872a74}{get\+\_\+qore\+\_\+option\+\_\+list()}} \end{DoxySeeAlso} \begin{DoxySince}{Since} Qore 0.\+8.\+4 \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_ga8ed2c5a0ee827317e265808c8f872a74}\label{group__misc__functions_ga8ed2c5a0ee827317e265808c8f872a74}} \index{Miscellaneous Functions@{Miscellaneous Functions}!get\_qore\_option\_list@{get\_qore\_option\_list}} \index{get\_qore\_option\_list@{get\_qore\_option\_list}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{get\_qore\_option\_list()}{get\_qore\_option\_list()}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_ga4b52a1cbee7a3aed46c32cb0a938629c}{list}}$<$\mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$auto$>$ $>$ Qore\+::get\+\_\+qore\+\_\+option\+\_\+list (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} Returns a list of hashes giving information about Qore library options for the current build. \begin{DoxyReturn}{Returns} a list of hashes giving information about Qore library options for the current build; each hash will have the following keys\+: \begin{DoxyItemize} \item {\ttfamily option\+:} The string description of the option \item {\ttfamily constant\+:} A string giving the name of the constant that has the boolean value for this option \item {\ttfamily type\+:} The type of option \item {\ttfamily value\+:} The boolean value of the option \end{DoxyItemize} \end{DoxyReturn} \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{list> l = \mbox{\hyperlink{group__misc__functions_ga8ed2c5a0ee827317e265808c8f872a74}{get\_qore\_option\_list}}();} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxySeeAlso}{See also} \mbox{\hyperlink{group__misc__functions_ga1fe51f94becc8165b08426434fe4f138}{get\+\_\+qore\+\_\+option\+\_\+hash()}} \end{DoxySeeAlso} \mbox{\Hypertarget{group__misc__functions_ga4730f5a695996be26efbfa9760417b1b}\label{group__misc__functions_ga4730f5a695996be26efbfa9760417b1b}} \index{Miscellaneous Functions@{Miscellaneous Functions}!get\_script\_dir@{get\_script\_dir}} \index{get\_script\_dir@{get\_script\_dir}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{get\_script\_dir()}{get\_script\_dir()}} {\footnotesize\ttfamily \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::get\+\_\+script\+\_\+dir (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} Returns the name of the directory from which the current script was executed or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if unknown (i.\+e. no parent script, script read from stdin, etc) \begin{DoxyReturn}{Returns} the name of the directory from which the current script was executed or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if unknown (i.\+e. no parent script, script read from stdin, etc) \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{*string str = \mbox{\hyperlink{group__misc__functions_ga4730f5a695996be26efbfa9760417b1b}{get\_script\_dir}}();} \end{DoxyCode} \end{DoxyParagraph} \mbox{\Hypertarget{group__misc__functions_gade1f45f4d12597822362d920c84695a5}\label{group__misc__functions_gade1f45f4d12597822362d920c84695a5}} \index{Miscellaneous Functions@{Miscellaneous Functions}!get\_script\_name@{get\_script\_name}} \index{get\_script\_name@{get\_script\_name}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{get\_script\_name()}{get\_script\_name()}} {\footnotesize\ttfamily \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::get\+\_\+script\+\_\+name (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} Returns the filename of the current script if known or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if unknown (i.\+e. no parent script, script read from stdin, etc) \begin{DoxyReturn}{Returns} the filename of the current script if known or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if unknown (i.\+e. no parent script, script read from stdin, etc) \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{*string str = \mbox{\hyperlink{group__misc__functions_gade1f45f4d12597822362d920c84695a5}{get\_script\_name}}();} \end{DoxyCode} \end{DoxyParagraph} \mbox{\Hypertarget{group__misc__functions_ga3ebc5d7d350677395e4b89686ca335b4}\label{group__misc__functions_ga3ebc5d7d350677395e4b89686ca335b4}} \index{Miscellaneous Functions@{Miscellaneous Functions}!get\_script\_path@{get\_script\_path}} \index{get\_script\_path@{get\_script\_path}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{get\_script\_path()}{get\_script\_path()}} {\footnotesize\ttfamily \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::get\+\_\+script\+\_\+path (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} Returns the path (directory and filename) of the current script or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if unknown (i.\+e. no parent script, script read from stdin, etc) \begin{DoxyReturn}{Returns} the path (directory and filename) of the current script or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if unknown (i.\+e. no parent script, script read from stdin, etc) \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{*string str = \mbox{\hyperlink{group__misc__functions_ga3ebc5d7d350677395e4b89686ca335b4}{get\_script\_path}}();} \end{DoxyCode} \end{DoxyParagraph} \mbox{\Hypertarget{group__misc__functions_gad19c4c14c864af9759effecbfef6d68a}\label{group__misc__functions_gad19c4c14c864af9759effecbfef6d68a}} \index{Miscellaneous Functions@{Miscellaneous Functions}!get\_word\_16@{get\_word\_16}} \index{get\_word\_16@{get\_word\_16}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{get\_word\_16()}{get\_word\_16()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} {\footnotesize\ttfamily \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} Qore\+::get\+\_\+word\+\_\+16 (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}}}]{b, }\item[{softint}]{offset = {\ttfamily 0} }\end{DoxyParamCaption})} Returns the 16-\/bit integer value at the given 2-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. This function assumes \href{http://en.wikipedia.org/wiki/Most_significant_bit}{\texttt{ MSB byte order}} when retrieving the value from the data \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em b} & the data to process \\ \hline {\em offset} & the 2-\/byte offset of the data to retrieve (the first value is at offset 0)\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the 16-\/bit integer value at the given 2-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{*int val = \mbox{\hyperlink{group__misc__functions_ga5802a4f147d02009947401dd92e3b197}{get\_word\_16}}(bin, 2); \textcolor{comment}{\# returns the third 2-\/byte (16-\/bit) value in the binary object}} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxySeeAlso}{See also} \mbox{\hyperlink{group__misc__functions_ga8d9d7eb06b650954226a82502dcaa838}{get\+\_\+word\+\_\+16\+\_\+lsb()}} \end{DoxySeeAlso} \mbox{\Hypertarget{group__misc__functions_ga5802a4f147d02009947401dd92e3b197}\label{group__misc__functions_ga5802a4f147d02009947401dd92e3b197}} \index{Miscellaneous Functions@{Miscellaneous Functions}!get\_word\_16@{get\_word\_16}} \index{get\_word\_16@{get\_word\_16}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{get\_word\_16()}{get\_word\_16()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} {\footnotesize\ttfamily \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} Qore\+::get\+\_\+word\+\_\+16 (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{str, }\item[{softint}]{offset = {\ttfamily 0} }\end{DoxyParamCaption})} Returns the 16-\/bit integer value at the given 2-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. This function assumes \href{http://en.wikipedia.org/wiki/Most_significant_bit}{\texttt{ MSB byte order}} when retrieving the value from the data \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em str} & the string data to process \\ \hline {\em offset} & the 2-\/byte offset of the data to retrieve (the first value is at offset 0)\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the 16-\/bit integer value at the given 2-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{*int val = \mbox{\hyperlink{group__misc__functions_ga5802a4f147d02009947401dd92e3b197}{get\_word\_16}}(str, 2); \textcolor{comment}{\# returns the third 2-\/byte (16-\/bit) value in the string}} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxySeeAlso}{See also} \mbox{\hyperlink{group__misc__functions_ga8d9d7eb06b650954226a82502dcaa838}{get\+\_\+word\+\_\+16\+\_\+lsb()}} \end{DoxySeeAlso} \mbox{\Hypertarget{group__misc__functions_ga28d6b93d58fb1df8615a9701fa10fe52}\label{group__misc__functions_ga28d6b93d58fb1df8615a9701fa10fe52}} \index{Miscellaneous Functions@{Miscellaneous Functions}!get\_word\_16\_lsb@{get\_word\_16\_lsb}} \index{get\_word\_16\_lsb@{get\_word\_16\_lsb}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{get\_word\_16\_lsb()}{get\_word\_16\_lsb()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} {\footnotesize\ttfamily \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} Qore\+::get\+\_\+word\+\_\+16\+\_\+lsb (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}}}]{b, }\item[{softint}]{offset = {\ttfamily 0} }\end{DoxyParamCaption})} Returns the 16-\/bit integer value at the given 2-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. This function assumes \href{http://en.wikipedia.org/wiki/Least_significant_bit}{\texttt{ LSB byte order}} when retrieving the value from the data \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em b} & the data to process \\ \hline {\em offset} & the 2-\/byte offset of the data to retrieve (the first value is at offset 0)\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the 16-\/bit integer value at the given 2-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{*int val = \mbox{\hyperlink{group__misc__functions_ga8d9d7eb06b650954226a82502dcaa838}{get\_word\_16\_lsb}}(bin, 2); \textcolor{comment}{\# returns the third 2-\/byte (16-\/bit) value in the binary object}} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxySeeAlso}{See also} \mbox{\hyperlink{group__misc__functions_ga5802a4f147d02009947401dd92e3b197}{get\+\_\+word\+\_\+16()}} \end{DoxySeeAlso} \mbox{\Hypertarget{group__misc__functions_ga8d9d7eb06b650954226a82502dcaa838}\label{group__misc__functions_ga8d9d7eb06b650954226a82502dcaa838}} \index{Miscellaneous Functions@{Miscellaneous Functions}!get\_word\_16\_lsb@{get\_word\_16\_lsb}} \index{get\_word\_16\_lsb@{get\_word\_16\_lsb}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{get\_word\_16\_lsb()}{get\_word\_16\_lsb()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} {\footnotesize\ttfamily \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} Qore\+::get\+\_\+word\+\_\+16\+\_\+lsb (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{str, }\item[{softint}]{offset = {\ttfamily 0} }\end{DoxyParamCaption})} Returns the 16-\/bit integer value at the given 2-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. This function assumes \href{http://en.wikipedia.org/wiki/Least_significant_bit}{\texttt{ LSB byte order}} when retrieving the value from the data \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em str} & the string data to process \\ \hline {\em offset} & the 2-\/byte offset of the data to retrieve (the first value is at offset 0)\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the 16-\/bit integer value at the given 2-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{*int val = \mbox{\hyperlink{group__misc__functions_ga8d9d7eb06b650954226a82502dcaa838}{get\_word\_16\_lsb}}(str, 2); \textcolor{comment}{\# returns the third 2-\/byte (16-\/bit) value in the string}} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxySeeAlso}{See also} \mbox{\hyperlink{group__misc__functions_ga5802a4f147d02009947401dd92e3b197}{get\+\_\+word\+\_\+16()}} \end{DoxySeeAlso} \mbox{\Hypertarget{group__misc__functions_ga1124c85d897be618a9e61c1fbccd37d9}\label{group__misc__functions_ga1124c85d897be618a9e61c1fbccd37d9}} \index{Miscellaneous Functions@{Miscellaneous Functions}!get\_word\_32@{get\_word\_32}} \index{get\_word\_32@{get\_word\_32}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{get\_word\_32()}{get\_word\_32()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} {\footnotesize\ttfamily \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} Qore\+::get\+\_\+word\+\_\+32 (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}}}]{b, }\item[{softint}]{offset = {\ttfamily 0} }\end{DoxyParamCaption})} Returns the 32-\/bit integer value at the given 4-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. This function assumes \href{http://en.wikipedia.org/wiki/Most_significant_bit}{\texttt{ MSB byte order}} when retrieving the value from the data \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em b} & the data to process \\ \hline {\em offset} & the 4-\/byte offset of the data to retrieve (the first value is at offset 0)\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the 32-\/bit integer value at the given 4-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{*int val = \mbox{\hyperlink{group__misc__functions_gae5d20bf535d84eee3ae17402b3ac4ec7}{get\_word\_32}}(bin, 2); \textcolor{comment}{\# returns the third 4-\/byte (32-\/bit) value in the binary object}} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyNote}{Note} This function is identical to \mbox{\hyperlink{group__misc__functions_gaed6fd3c7569dbd820cff0fc1e23db555}{get\+Word32()}}, except this function has no \mbox{\hyperlink{code_flags_RUNTIME_NOOP}{RUNTIME\+\_\+\+NOOP}} variant \end{DoxyNote} \begin{DoxySeeAlso}{See also} \mbox{\hyperlink{group__misc__functions_ga29b56ac9ee5c55bf8243b3060388be02}{get\+\_\+word\+\_\+32\+\_\+lsb()}} \end{DoxySeeAlso} \mbox{\Hypertarget{group__misc__functions_gae5d20bf535d84eee3ae17402b3ac4ec7}\label{group__misc__functions_gae5d20bf535d84eee3ae17402b3ac4ec7}} \index{Miscellaneous Functions@{Miscellaneous Functions}!get\_word\_32@{get\_word\_32}} \index{get\_word\_32@{get\_word\_32}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{get\_word\_32()}{get\_word\_32()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} {\footnotesize\ttfamily \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} Qore\+::get\+\_\+word\+\_\+32 (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{str, }\item[{softint}]{offset = {\ttfamily 0} }\end{DoxyParamCaption})} Returns the 32-\/bit integer value at the given 4-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. This function assumes \href{http://en.wikipedia.org/wiki/Most_significant_bit}{\texttt{ MSB byte order}} when retrieving the value from the data \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em str} & the string data to process \\ \hline {\em offset} & the 4-\/byte offset of the data to retrieve (the first value is at offset 0)\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the 32-\/bit integer value at the given 4-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{*int val = \mbox{\hyperlink{group__misc__functions_gae5d20bf535d84eee3ae17402b3ac4ec7}{get\_word\_32}}(str, 4); \textcolor{comment}{\# returns the third 4-\/byte (32-\/bit) value in the string}} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyNote}{Note} This function is identical to \mbox{\hyperlink{group__misc__functions_gaed6fd3c7569dbd820cff0fc1e23db555}{get\+Word32()}}, except this function has no \mbox{\hyperlink{code_flags_RUNTIME_NOOP}{RUNTIME\+\_\+\+NOOP}} variant \end{DoxyNote} \begin{DoxySeeAlso}{See also} \mbox{\hyperlink{group__misc__functions_ga29b56ac9ee5c55bf8243b3060388be02}{get\+\_\+word\+\_\+32\+\_\+lsb()}} \end{DoxySeeAlso} \mbox{\Hypertarget{group__misc__functions_ga2269ca395fdfe9214039952c4cacf730}\label{group__misc__functions_ga2269ca395fdfe9214039952c4cacf730}} \index{Miscellaneous Functions@{Miscellaneous Functions}!get\_word\_32\_lsb@{get\_word\_32\_lsb}} \index{get\_word\_32\_lsb@{get\_word\_32\_lsb}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{get\_word\_32\_lsb()}{get\_word\_32\_lsb()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} {\footnotesize\ttfamily \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} Qore\+::get\+\_\+word\+\_\+32\+\_\+lsb (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}}}]{b, }\item[{softint}]{offset = {\ttfamily 0} }\end{DoxyParamCaption})} Returns the 32-\/bit integer value at the given 4-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. This function assumes \href{http://en.wikipedia.org/wiki/Least_significant_bit}{\texttt{ LSB byte order}} when retrieving the value from the data \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em b} & the data to process \\ \hline {\em offset} & the 4-\/byte offset of the data to retrieve (the first value is at offset 0)\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the 32-\/bit integer value at the given 4-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{*int val = \mbox{\hyperlink{group__misc__functions_ga29b56ac9ee5c55bf8243b3060388be02}{get\_word\_32\_lsb}}(bin, 2); \textcolor{comment}{\# returns the third 4-\/byte (32-\/bit) value in the binary object}} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxySeeAlso}{See also} \mbox{\hyperlink{group__misc__functions_gae5d20bf535d84eee3ae17402b3ac4ec7}{get\+\_\+word\+\_\+32()}} \end{DoxySeeAlso} \mbox{\Hypertarget{group__misc__functions_ga29b56ac9ee5c55bf8243b3060388be02}\label{group__misc__functions_ga29b56ac9ee5c55bf8243b3060388be02}} \index{Miscellaneous Functions@{Miscellaneous Functions}!get\_word\_32\_lsb@{get\_word\_32\_lsb}} \index{get\_word\_32\_lsb@{get\_word\_32\_lsb}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{get\_word\_32\_lsb()}{get\_word\_32\_lsb()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} {\footnotesize\ttfamily \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} Qore\+::get\+\_\+word\+\_\+32\+\_\+lsb (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{str, }\item[{softint}]{offset = {\ttfamily 0} }\end{DoxyParamCaption})} Returns the 32-\/bit integer value at the given 4-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. This function assumes \href{http://en.wikipedia.org/wiki/Least_significant_bit}{\texttt{ LSB byte order}} when retrieving the value from the data \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em str} & the string data to process \\ \hline {\em offset} & the 4-\/byte offset of the data to retrieve (the first value is at offset 0)\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the 32-\/bit integer value at the given 4-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{*int val = \mbox{\hyperlink{group__misc__functions_ga29b56ac9ee5c55bf8243b3060388be02}{get\_word\_32\_lsb}}(str, 4); \textcolor{comment}{\# returns the third 4-\/byte (32-\/bit) value in the string}} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyNote}{Note} This function is identical to \mbox{\hyperlink{group__misc__functions_gaed6fd3c7569dbd820cff0fc1e23db555}{get\+Word32()}}, except this function has no \mbox{\hyperlink{code_flags_RUNTIME_NOOP}{RUNTIME\+\_\+\+NOOP}} variant \end{DoxyNote} \begin{DoxySeeAlso}{See also} \mbox{\hyperlink{group__misc__functions_gae5d20bf535d84eee3ae17402b3ac4ec7}{get\+\_\+word\+\_\+32()}} \end{DoxySeeAlso} \mbox{\Hypertarget{group__misc__functions_ga6fbc2c59ad0af1fe6a9e87b6f037d331}\label{group__misc__functions_ga6fbc2c59ad0af1fe6a9e87b6f037d331}} \index{Miscellaneous Functions@{Miscellaneous Functions}!get\_word\_64@{get\_word\_64}} \index{get\_word\_64@{get\_word\_64}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{get\_word\_64()}{get\_word\_64()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} {\footnotesize\ttfamily \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} Qore\+::get\+\_\+word\+\_\+64 (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}}}]{b, }\item[{softint}]{offset = {\ttfamily 0} }\end{DoxyParamCaption})} Returns the 64-\/bit integer value at the given 8-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. This function assumes \href{http://en.wikipedia.org/wiki/Most_significant_bit}{\texttt{ MSB byte order}} when retrieving the value from the data \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em b} & the data to process \\ \hline {\em offset} & the 8-\/byte offset of the data to retrieve (the first value is at offset 0)\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the 64-\/bit integer value at the given 8-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{*int val = \mbox{\hyperlink{group__misc__functions_gadf53ee1d46382bf4cb2c4fd12816a5c8}{get\_word\_64}}(bin, 2); \textcolor{comment}{\# returns the third 8-\/byte (64-\/bit) value in the binary object}} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxySeeAlso}{See also} \mbox{\hyperlink{group__misc__functions_gac260e3cfffb2c9ac8e69a1428183de01}{get\+\_\+word\+\_\+64\+\_\+lsb()}} \end{DoxySeeAlso} \mbox{\Hypertarget{group__misc__functions_gadf53ee1d46382bf4cb2c4fd12816a5c8}\label{group__misc__functions_gadf53ee1d46382bf4cb2c4fd12816a5c8}} \index{Miscellaneous Functions@{Miscellaneous Functions}!get\_word\_64@{get\_word\_64}} \index{get\_word\_64@{get\_word\_64}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{get\_word\_64()}{get\_word\_64()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} {\footnotesize\ttfamily \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} Qore\+::get\+\_\+word\+\_\+64 (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{str, }\item[{softint}]{offset = {\ttfamily 0} }\end{DoxyParamCaption})} Returns the 64-\/bit integer value at the given 8-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. This function assumes \href{http://en.wikipedia.org/wiki/Most_significant_bit}{\texttt{ MSB byte order}} when retrieving the value from the data \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em str} & the string data to process \\ \hline {\em offset} & the 8-\/byte offset of the data to retrieve (the first value is at offset 0)\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the 64-\/bit integer value at the given 8-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{*int val = \mbox{\hyperlink{group__misc__functions_gadf53ee1d46382bf4cb2c4fd12816a5c8}{get\_word\_64}}(str, 4); \textcolor{comment}{\# returns the third 8-\/byte (64-\/bit) value in the string}} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxySeeAlso}{See also} \mbox{\hyperlink{group__misc__functions_gac260e3cfffb2c9ac8e69a1428183de01}{get\+\_\+word\+\_\+64\+\_\+lsb()}} \end{DoxySeeAlso} \mbox{\Hypertarget{group__misc__functions_ga08294fc87d5f9d127cdd794085c59072}\label{group__misc__functions_ga08294fc87d5f9d127cdd794085c59072}} \index{Miscellaneous Functions@{Miscellaneous Functions}!get\_word\_64\_lsb@{get\_word\_64\_lsb}} \index{get\_word\_64\_lsb@{get\_word\_64\_lsb}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{get\_word\_64\_lsb()}{get\_word\_64\_lsb()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} {\footnotesize\ttfamily \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} Qore\+::get\+\_\+word\+\_\+64\+\_\+lsb (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}}}]{b, }\item[{softint}]{offset = {\ttfamily 0} }\end{DoxyParamCaption})} Returns the 64-\/bit integer value at the given 8-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. This function assumes \href{http://en.wikipedia.org/wiki/Least_significant_bit}{\texttt{ LSB byte order}} when retrieving the value from the data \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em b} & the data to process \\ \hline {\em offset} & the 8-\/byte offset of the data to retrieve (the first value is at offset 0)\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the 64-\/bit integer value at the given 8-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{*int val = \mbox{\hyperlink{group__misc__functions_gac260e3cfffb2c9ac8e69a1428183de01}{get\_word\_64\_lsb}}(bin, 2); \textcolor{comment}{\# returns the third 8-\/byte (64-\/bit) value in the binary object}} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxySeeAlso}{See also} \mbox{\hyperlink{group__misc__functions_gadf53ee1d46382bf4cb2c4fd12816a5c8}{get\+\_\+word\+\_\+64()}} \end{DoxySeeAlso} \mbox{\Hypertarget{group__misc__functions_gac260e3cfffb2c9ac8e69a1428183de01}\label{group__misc__functions_gac260e3cfffb2c9ac8e69a1428183de01}} \index{Miscellaneous Functions@{Miscellaneous Functions}!get\_word\_64\_lsb@{get\_word\_64\_lsb}} \index{get\_word\_64\_lsb@{get\_word\_64\_lsb}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{get\_word\_64\_lsb()}{get\_word\_64\_lsb()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} {\footnotesize\ttfamily \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} Qore\+::get\+\_\+word\+\_\+64\+\_\+lsb (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{str, }\item[{softint}]{offset = {\ttfamily 0} }\end{DoxyParamCaption})} Returns the 64-\/bit integer value at the given 8-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. This function assumes \href{http://en.wikipedia.org/wiki/Least_significant_bit}{\texttt{ LSB byte order}} when retrieving the value from the data \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em str} & the string data to process \\ \hline {\em offset} & the 8-\/byte offset of the data to retrieve (the first value is at offset 0)\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the 64-\/bit integer value at the given 8-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{*int val = \mbox{\hyperlink{group__misc__functions_gac260e3cfffb2c9ac8e69a1428183de01}{get\_word\_64\_lsb}}(str, 4); \textcolor{comment}{\# returns the third 8-\/byte (64-\/bit) value in the string}} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxySeeAlso}{See also} \mbox{\hyperlink{group__misc__functions_gadf53ee1d46382bf4cb2c4fd12816a5c8}{get\+\_\+word\+\_\+64()}} \end{DoxySeeAlso} \mbox{\Hypertarget{group__misc__functions_gadfbef79c0c3442d2d7857f6ba1d56049}\label{group__misc__functions_gadfbef79c0c3442d2d7857f6ba1d56049}} \index{Miscellaneous Functions@{Miscellaneous Functions}!getByte@{getByte}} \index{getByte@{getByte}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{getByte()}{getByte()}\hspace{0.1cm}{\footnotesize\ttfamily [1/3]}} {\footnotesize\ttfamily nothing Qore\+::get\+Byte (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_RUNTIME_NOOP}{RUNTIME\+\_\+\+NOOP}}, \mbox{\hyperlink{code_flags_DEPRECATED}{DEPRECATED}} \end{DoxyParagraph} \mbox{\Hypertarget{group__misc__functions_gad79fe036448819f5e392ef443b60b97d}\label{group__misc__functions_gad79fe036448819f5e392ef443b60b97d}} \index{Miscellaneous Functions@{Miscellaneous Functions}!getByte@{getByte}} \index{getByte@{getByte}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{getByte()}{getByte()}\hspace{0.1cm}{\footnotesize\ttfamily [2/3]}} {\footnotesize\ttfamily \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} Qore\+::get\+Byte (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}}}]{b, }\item[{softint}]{offset = {\ttfamily 0} }\end{DoxyParamCaption})} Returns the byte value at the given byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}}, \mbox{\hyperlink{code_flags_DEPRECATED}{DEPRECATED}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em b} & the data to process \\ \hline {\em offset} & the byte offset of the data to retrieve (the first value is at offset 0)\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the byte value at the given byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data \end{DoxyReturn} \begin{DoxyNote}{Note} this function is equivalent to the more efficient \mbox{\hyperlink{operators_list_element_operator}{\mbox{[}\mbox{]} operator}} when used with a binary argument~\newline ~\newline Furthermore this function is identical to \mbox{\hyperlink{group__misc__functions_ga24aed47f45573187b6644d5ec1a3aeb5}{get\+\_\+byte()}}, except this function has a \mbox{\hyperlink{code_flags_RUNTIME_NOOP}{RUNTIME\+\_\+\+NOOP}} variant \end{DoxyNote} \begin{DoxyRefDesc}{Deprecated} \item[\mbox{\hyperlink{deprecated__deprecated000019}{Deprecated}}]Qore 0.\+8.\+4 marked as deprecated; use the \mbox{\hyperlink{group__misc__functions_ga24aed47f45573187b6644d5ec1a3aeb5}{get\+\_\+byte()}} function instead \end{DoxyRefDesc} \mbox{\Hypertarget{group__misc__functions_ga3a6b906bee63eb28d20610da64fd5417}\label{group__misc__functions_ga3a6b906bee63eb28d20610da64fd5417}} \index{Miscellaneous Functions@{Miscellaneous Functions}!getByte@{getByte}} \index{getByte@{getByte}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{getByte()}{getByte()}\hspace{0.1cm}{\footnotesize\ttfamily [3/3]}} {\footnotesize\ttfamily \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} Qore\+::get\+Byte (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{str, }\item[{softint}]{offset = {\ttfamily 0} }\end{DoxyParamCaption})} Returns the byte value at the given byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}}, \mbox{\hyperlink{code_flags_DEPRECATED}{DEPRECATED}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em str} & the string data to process \\ \hline {\em offset} & the byte offset of the data to retrieve (the first value is at offset 0)\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the byte value at the given byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data \end{DoxyReturn} \begin{DoxyNote}{Note} that for strings this function is not equivalent to the \mbox{\hyperlink{operators_list_element_operator}{\mbox{[}\mbox{]} operator}} for multi-\/byte character encodings, as this function works purely on bytes and the \mbox{\hyperlink{operators_list_element_operator}{\mbox{[}\mbox{]} operator}} operates on characters~\newline ~\newline Furthermore this function is identical to \mbox{\hyperlink{group__misc__functions_ga24aed47f45573187b6644d5ec1a3aeb5}{get\+\_\+byte()}}, except this function has a \mbox{\hyperlink{code_flags_RUNTIME_NOOP}{RUNTIME\+\_\+\+NOOP}} variant \end{DoxyNote} \begin{DoxyRefDesc}{Deprecated} \item[\mbox{\hyperlink{deprecated__deprecated000018}{Deprecated}}]since Qore 0.\+8.\+4 marked as deprecated; use the \mbox{\hyperlink{group__misc__functions_ga24aed47f45573187b6644d5ec1a3aeb5}{get\+\_\+byte()}} function instead \end{DoxyRefDesc} \mbox{\Hypertarget{group__misc__functions_ga69cdaa7f57458a60221fbed9ac2feb38}\label{group__misc__functions_ga69cdaa7f57458a60221fbed9ac2feb38}} \index{Miscellaneous Functions@{Miscellaneous Functions}!getClassName@{getClassName}} \index{getClassName@{getClassName}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{getClassName()}{getClassName()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} {\footnotesize\ttfamily nothing Qore\+::get\+Class\+Name (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_RUNTIME_NOOP}{RUNTIME\+\_\+\+NOOP}}, \mbox{\hyperlink{code_flags_DEPRECATED}{DEPRECATED}} \end{DoxyParagraph} \mbox{\Hypertarget{group__misc__functions_ga46b9c2df48897cb68e765cb6d66728ac}\label{group__misc__functions_ga46b9c2df48897cb68e765cb6d66728ac}} \index{Miscellaneous Functions@{Miscellaneous Functions}!getClassName@{getClassName}} \index{getClassName@{getClassName}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{getClassName()}{getClassName()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::get\+Class\+Name (\begin{DoxyParamCaption}\item[{object}]{obj }\end{DoxyParamCaption})} Returns the class name of the object passed. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}}, \mbox{\hyperlink{code_flags_DEPRECATED}{DEPRECATED}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em obj} & the object to get the class name of \\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the class name of the object passed \end{DoxyReturn} \begin{DoxyRefDesc}{Deprecated} \item[\mbox{\hyperlink{deprecated__deprecated000020}{Deprecated}}]use \mbox{\hyperlink{group__misc__functions_gaa9a0d3f277ef8cbdc99fe146dd3db49b}{get\+\_\+class\+\_\+name()}}; camel-\/case function names were deprecated in Qore 0.\+8.\+12 \end{DoxyRefDesc} \mbox{\Hypertarget{group__misc__functions_ga82a9721ba77a2a344b0e356d45c5a37f}\label{group__misc__functions_ga82a9721ba77a2a344b0e356d45c5a37f}} \index{Miscellaneous Functions@{Miscellaneous Functions}!getFeatureList@{getFeatureList}} \index{getFeatureList@{getFeatureList}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{getFeatureList()}{getFeatureList()}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_ga4b52a1cbee7a3aed46c32cb0a938629c}{list}}$<$\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}$>$ Qore\+::get\+Feature\+List (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} Returns a list of strings of the builtin and module-\/supplied features of \mbox{\hyperlink{namespace_qore}{Qore}}. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_DEPRECATED}{DEPRECATED}} \end{DoxyParagraph} \begin{DoxyReturn}{Returns} a list of strings of the builtin and module-\/supplied features of \mbox{\hyperlink{namespace_qore}{Qore}} \end{DoxyReturn} \begin{DoxyNote}{Note} this function is not flagged with \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} since its value could change at runtime \end{DoxyNote} \begin{DoxyRefDesc}{Deprecated} \item[\mbox{\hyperlink{deprecated__deprecated000021}{Deprecated}}]use \mbox{\hyperlink{group__misc__functions_ga86de08439e084c19460ae57d3d6269e5}{get\+\_\+feature\+\_\+list()}}; camel-\/case function names were deprecated in Qore 0.\+8.\+12 \end{DoxyRefDesc} \mbox{\Hypertarget{group__misc__functions_ga34248adafed4b00da2a526f8f23017cf}\label{group__misc__functions_ga34248adafed4b00da2a526f8f23017cf}} \index{Miscellaneous Functions@{Miscellaneous Functions}!getModuleHash@{getModuleHash}} \index{getModuleHash@{getModuleHash}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{getModuleHash()}{getModuleHash()}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}},\mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$auto$>$ $>$ Qore\+::get\+Module\+Hash (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} Returns a hash of hashes describing the currently-\/loaded Qore modules; the top-\/level hash keys are the module names. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_DEPRECATED}{DEPRECATED}} \end{DoxyParagraph} \begin{DoxyReturn}{Returns} a hash of hashes describing the currently-\/loaded Qore modules; the top-\/level hash keys are the module names; the values are hashes with the following keys\+: \begin{DoxyItemize} \item {\ttfamily filename\+:} the path to the module \item {\ttfamily name\+:} the name of the module \item {\ttfamily desc\+:} the description of the module \item {\ttfamily version\+:} the version of the module \item {\ttfamily author\+:} the author of the module \item {\ttfamily api\+\_\+major\+:} the major number of the Qore module API version the module support \item {\ttfamily api\+\_\+minor\+:} the minor number of the Qore module API version the module support \item {\ttfamily url\+:} the module\textquotesingle{}s URL \item {\ttfamily license\+:} the module\textquotesingle{}s license \end{DoxyItemize} \end{DoxyReturn} \begin{DoxyNote}{Note} this function is not flagged with \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} since its value could change at runtime \end{DoxyNote} \begin{DoxySince}{Since} Qore 0.\+8.\+1 \end{DoxySince} \begin{DoxyRefDesc}{Deprecated} \item[\mbox{\hyperlink{deprecated__deprecated000022}{Deprecated}}]use \mbox{\hyperlink{group__misc__functions_gab64b871ddf6f09568d4a0798c0ca755a}{get\+\_\+module\+\_\+hash()}}; camel-\/case function names were deprecated in Qore 0.\+8.\+12 \end{DoxyRefDesc} \mbox{\Hypertarget{group__misc__functions_ga82506074037fe39372ea4f44e2582a75}\label{group__misc__functions_ga82506074037fe39372ea4f44e2582a75}} \index{Miscellaneous Functions@{Miscellaneous Functions}!getModuleList@{getModuleList}} \index{getModuleList@{getModuleList}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{getModuleList()}{getModuleList()}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_ga4b52a1cbee7a3aed46c32cb0a938629c}{list}}$<$\mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$auto$>$ $>$ Qore\+::get\+Module\+List (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} Returns a list of hashes describing the currently-\/loaded Qore modules. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_DEPRECATED}{DEPRECATED}} \end{DoxyParagraph} \begin{DoxyReturn}{Returns} a list of hashes describing the currently-\/loaded Qore modules; each element in the list is a hash with the following keys\+: \begin{DoxyItemize} \item {\ttfamily filename\+:} the path to the module \item {\ttfamily name\+:} the name of the module \item {\ttfamily desc\+:} the description of the module \item {\ttfamily version\+:} the version of the module \item {\ttfamily author\+:} the author of the module \item {\ttfamily api\+\_\+major\+:} the major number of the Qore module API version the module support \item {\ttfamily api\+\_\+minor\+:} the minor number of the Qore module API version the module support \item {\ttfamily url\+:} the module\textquotesingle{}s URL \item {\ttfamily license\+:} the module\textquotesingle{}s license \end{DoxyItemize} \end{DoxyReturn} \begin{DoxyNote}{Note} this function is not flagged with \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} since its value could change at runtime \end{DoxyNote} \begin{DoxySeeAlso}{See also} \mbox{\hyperlink{group__misc__functions_gab64b871ddf6f09568d4a0798c0ca755a}{get\+\_\+module\+\_\+hash()}} \end{DoxySeeAlso} \begin{DoxyRefDesc}{Deprecated} \item[\mbox{\hyperlink{deprecated__deprecated000023}{Deprecated}}]use \mbox{\hyperlink{group__misc__functions_ga18cc840553c5850216308dbefa9d5a78}{get\+\_\+module\+\_\+list()}}; camel-\/case function names were deprecated in Qore 0.\+8.\+12 \end{DoxyRefDesc} \mbox{\Hypertarget{group__misc__functions_ga11bb1ea838d7c14802f3810ed0cbfdb2}\label{group__misc__functions_ga11bb1ea838d7c14802f3810ed0cbfdb2}} \index{Miscellaneous Functions@{Miscellaneous Functions}!getWord32@{getWord32}} \index{getWord32@{getWord32}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{getWord32()}{getWord32()}\hspace{0.1cm}{\footnotesize\ttfamily [1/3]}} {\footnotesize\ttfamily nothing Qore\+::get\+Word32 (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_RUNTIME_NOOP}{RUNTIME\+\_\+\+NOOP}}, \mbox{\hyperlink{code_flags_DEPRECATED}{DEPRECATED}} \end{DoxyParagraph} \mbox{\Hypertarget{group__misc__functions_ga771e2f1f122ccd8574354abdff42c192}\label{group__misc__functions_ga771e2f1f122ccd8574354abdff42c192}} \index{Miscellaneous Functions@{Miscellaneous Functions}!getWord32@{getWord32}} \index{getWord32@{getWord32}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{getWord32()}{getWord32()}\hspace{0.1cm}{\footnotesize\ttfamily [2/3]}} {\footnotesize\ttfamily \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} Qore\+::get\+Word32 (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}}}]{b, }\item[{softint}]{offset = {\ttfamily 0} }\end{DoxyParamCaption})} Returns the 32-\/bit integer value at the given 4-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. This function assumes \href{http://en.wikipedia.org/wiki/Most_significant_bit}{\texttt{ MSB byte order}} when retrieving the value from the data \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}}, \mbox{\hyperlink{code_flags_DEPRECATED}{DEPRECATED}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em b} & the data to process \\ \hline {\em offset} & the 4-\/byte offset of the data to retrieve (the first value is at offset 0)\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the 32-\/bit integer value at the given 4-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data \end{DoxyReturn} \begin{DoxyNote}{Note} This function is identical to \mbox{\hyperlink{group__misc__functions_gae5d20bf535d84eee3ae17402b3ac4ec7}{get\+\_\+word\+\_\+32()}}, except this function has a \mbox{\hyperlink{code_flags_RUNTIME_NOOP}{RUNTIME\+\_\+\+NOOP}} variant \end{DoxyNote} \begin{DoxyRefDesc}{Deprecated} \item[\mbox{\hyperlink{deprecated__deprecated000025}{Deprecated}}]Qore 0.\+8.\+4 marked as deprecated; use the \mbox{\hyperlink{group__misc__functions_gae5d20bf535d84eee3ae17402b3ac4ec7}{get\+\_\+word\+\_\+32()}} function instead \end{DoxyRefDesc} \mbox{\Hypertarget{group__misc__functions_gaed6fd3c7569dbd820cff0fc1e23db555}\label{group__misc__functions_gaed6fd3c7569dbd820cff0fc1e23db555}} \index{Miscellaneous Functions@{Miscellaneous Functions}!getWord32@{getWord32}} \index{getWord32@{getWord32}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{getWord32()}{getWord32()}\hspace{0.1cm}{\footnotesize\ttfamily [3/3]}} {\footnotesize\ttfamily \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} Qore\+::get\+Word32 (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{str, }\item[{softint}]{offset = {\ttfamily 0} }\end{DoxyParamCaption})} Returns the 32-\/bit integer value at the given 4-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data. This function assumes \href{http://en.wikipedia.org/wiki/Most_significant_bit}{\texttt{ MSB byte order}} when retrieving the value from the data \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}}, \mbox{\hyperlink{code_flags_DEPRECATED}{DEPRECATED}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em str} & the string data to process \\ \hline {\em offset} & the 4-\/byte offset of the data to retrieve (the first value is at offset 0)\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the 32-\/bit integer value at the given 4-\/byte offset (the first value is at offset 0) or \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} if the offset is not legal for the given data \end{DoxyReturn} \begin{DoxyNote}{Note} This function is identical to \mbox{\hyperlink{group__misc__functions_gae5d20bf535d84eee3ae17402b3ac4ec7}{get\+\_\+word\+\_\+32()}}, except this function has a \mbox{\hyperlink{code_flags_RUNTIME_NOOP}{RUNTIME\+\_\+\+NOOP}} variant \end{DoxyNote} \begin{DoxyRefDesc}{Deprecated} \item[\mbox{\hyperlink{deprecated__deprecated000024}{Deprecated}}]Qore 0.\+8.\+4 marked as deprecated; use the \mbox{\hyperlink{group__misc__functions_gae5d20bf535d84eee3ae17402b3ac4ec7}{get\+\_\+word\+\_\+32()}} function instead \end{DoxyRefDesc} \mbox{\Hypertarget{group__misc__functions_ga6e0d48075f4f39939f6354aa7060e5b4}\label{group__misc__functions_ga6e0d48075f4f39939f6354aa7060e5b4}} \index{Miscellaneous Functions@{Miscellaneous Functions}!has\_key@{has\_key}} \index{has\_key@{has\_key}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{has\_key()}{has\_key()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} {\footnotesize\ttfamily bool Qore\+::has\+\_\+key (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$ auto $>$}]{h, }\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{key }\end{DoxyParamCaption})} Returns \mbox{\hyperlink{basic_data_types_True}{True}} if the given key exists in the hash (does not necessarily have to have a value assigned); exceptions are only raised if string encoding errors are encountered. \begin{DoxyParams}{Parameters} {\em h} & the hash to check \\ \hline {\em key} & the key name to check; this value will be converted to the \mbox{\hyperlink{character_encoding_default_encoding}{default character encoding}} to check the hash\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} \mbox{\hyperlink{basic_data_types_True}{True}} if the given key exists in the hash (does not necessarily have to have a value assigned), \mbox{\hyperlink{basic_data_types_False}{False}} if the key is not present at all \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{bool b = \mbox{\hyperlink{group__misc__functions_ga6e0d48075f4f39939f6354aa7060e5b4}{has\_key}}(hash, \textcolor{stringliteral}{"{}key"{}});} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyNote}{Note} no exception is thrown when checking an invalid key in a \mbox{\hyperlink{hashdecl}{hashdecl}}-\/derived hash \end{DoxyNote} \begin{DoxyExceptions}{Exceptions} {\em ENCODING-\/\+CONVERSION-\/\+ERROR} & this error is thrown if the given key cannot be converted to the \mbox{\hyperlink{character_encoding_default_encoding}{default character encoding}} \\ \hline \end{DoxyExceptions} \mbox{\Hypertarget{group__misc__functions_ga5cf258d64631c0422ee15e0796361b28}\label{group__misc__functions_ga5cf258d64631c0422ee15e0796361b28}} \index{Miscellaneous Functions@{Miscellaneous Functions}!has\_key@{has\_key}} \index{has\_key@{has\_key}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{has\_key()}{has\_key()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} {\footnotesize\ttfamily bool Qore\+::has\+\_\+key (\begin{DoxyParamCaption}\item[{object}]{obj, }\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{key }\end{DoxyParamCaption})} Returns \mbox{\hyperlink{basic_data_types_True}{True}} if the given key exists in the object (does not necessarily have to have a value assigned); exceptions are only raised if string encoding errors are encountered or in case of object access errors. \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{bool b = \mbox{\hyperlink{group__misc__functions_ga6e0d48075f4f39939f6354aa7060e5b4}{has\_key}}(obj, \textcolor{stringliteral}{"{}key"{}});} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyExceptions}{Exceptions} {\em ENCODING-\/\+CONVERSION-\/\+ERROR} & this error is thrown if the given key cannot be converted to the \mbox{\hyperlink{character_encoding_default_encoding}{default character encoding}}\\ \hline \end{DoxyExceptions} \begin{DoxyNote}{Note} object access exceptions could also be raised \end{DoxyNote} \mbox{\Hypertarget{group__misc__functions_ga6f07280e7c9ab676913b6fcb84588610}\label{group__misc__functions_ga6f07280e7c9ab676913b6fcb84588610}} \index{Miscellaneous Functions@{Miscellaneous Functions}!hash\_values@{hash\_values}} \index{hash\_values@{hash\_values}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{hash\_values()}{hash\_values()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} {\footnotesize\ttfamily nothing Qore\+::hash\+\_\+values (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_RUNTIME_NOOP}{RUNTIME\+\_\+\+NOOP}} \end{DoxyParagraph} \mbox{\Hypertarget{group__misc__functions_gaf5d769ebf4e89f22c223f36beacf5000}\label{group__misc__functions_gaf5d769ebf4e89f22c223f36beacf5000}} \index{Miscellaneous Functions@{Miscellaneous Functions}!hash\_values@{hash\_values}} \index{hash\_values@{hash\_values}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{hash\_values()}{hash\_values()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_ga4b52a1cbee7a3aed46c32cb0a938629c}{list}}$<$auto$>$ Qore\+::hash\+\_\+values (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$ auto $>$}]{h }\end{DoxyParamCaption})} Returns a list of all the values in the hash argument passed. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em h} & a hash to get all the values of\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} a list of all the values in the hash argument passed \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{list vl = \mbox{\hyperlink{group__misc__functions_gaf5d769ebf4e89f22c223f36beacf5000}{hash\_values}}(vl);} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyNote}{Note} equivalent to \mbox{\hyperlink{class_qore_1_1zzz8hashzzz9_aa0a89864ecb2f16870af201163a6e3a7}{Qore\+::zzz8hashzzz9\+::values()}} \end{DoxyNote} \begin{DoxySeeAlso}{See also} \mbox{\hyperlink{class_qore_1_1zzz8hashzzz9_abea95265a8d43bda81e922865978fa1f}{Qore\+::zzz8hashzzz9\+::keys()}} \end{DoxySeeAlso} \mbox{\Hypertarget{group__misc__functions_ga54d9807bf59a9e97284b12542a4c3ec6}\label{group__misc__functions_ga54d9807bf59a9e97284b12542a4c3ec6}} \index{Miscellaneous Functions@{Miscellaneous Functions}!hextoint@{hextoint}} \index{hextoint@{hextoint}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{hextoint()}{hextoint()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} {\footnotesize\ttfamily nothing Qore\+::hextoint (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_RUNTIME_NOOP}{RUNTIME\+\_\+\+NOOP}} \end{DoxyParagraph} \mbox{\Hypertarget{group__misc__functions_ga635c21b4901af8accbf5729682b90f20}\label{group__misc__functions_ga635c21b4901af8accbf5729682b90f20}} \index{Miscellaneous Functions@{Miscellaneous Functions}!hextoint@{hextoint}} \index{hextoint@{hextoint}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{hextoint()}{hextoint()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} Qore\+::hextoint (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{str }\end{DoxyParamCaption})} Returns an integer for a hexadecimal string value; throws an exception if non-\/hex digits are found. \begin{DoxyParams}{Parameters} {\em str} & a string of hexadecimal digits (like {\ttfamily \char`\"{}6d4f84e0\char`\"{}}; with or without leading {\ttfamily \char`\"{}x\char`\"{}} or {\ttfamily \char`\"{}0x\char`\"{}})\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the base-\/10 integer corresponding to the argument \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{int i = \mbox{\hyperlink{group__misc__functions_ga635c21b4901af8accbf5729682b90f20}{hextoint}}(\textcolor{stringliteral}{"{}ab3d4e0f12"{}});} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyExceptions}{Exceptions} {\em PARSE-\/\+HEX-\/\+ERROR} & invalid hex digit found \\ \hline \end{DoxyExceptions} \mbox{\Hypertarget{group__misc__functions_gad95ece28621404a42cf5e3f80193c84d}\label{group__misc__functions_gad95ece28621404a42cf5e3f80193c84d}} \index{Miscellaneous Functions@{Miscellaneous Functions}!html\_decode@{html\_decode}} \index{html\_decode@{html\_decode}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{html\_decode()}{html\_decode()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} {\footnotesize\ttfamily nothing Qore\+::html\+\_\+decode (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_RUNTIME_NOOP}{RUNTIME\+\_\+\+NOOP}} \end{DoxyParagraph} \mbox{\Hypertarget{group__misc__functions_gac6f51f8c4de37bc139346d6059961148}\label{group__misc__functions_gac6f51f8c4de37bc139346d6059961148}} \index{Miscellaneous Functions@{Miscellaneous Functions}!html\_decode@{html\_decode}} \index{html\_decode@{html\_decode}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{html\_decode()}{html\_decode()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::html\+\_\+decode (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{str }\end{DoxyParamCaption})} Returns a string with any HTML escape codes translated to the original characters. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em str} & the argument to decode\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the string passed as an argument with any HTML escape codes translated to the original characters \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{string str = \mbox{\hyperlink{group__misc__functions_gac6f51f8c4de37bc139346d6059961148}{html\_decode}}(\textcolor{stringliteral}{"{}\<hello\>"{}}); \textcolor{comment}{\# returns "{}"{}}} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyNote}{Note} equivalent to \mbox{\hyperlink{class_qore_1_1zzz8stringzzz9_a07b89a849ef94f060e0fcf2c040fd296}{Qore\+::zzz8stringzzz9\+::get\+Decoded()}} with \mbox{\hyperlink{group___string_concat_decoding_gac9d1ccf5b811ffa1d178baf0d0c6130e}{Qore\+::\+CD\+\_\+\+HTML}} \end{DoxyNote} \begin{DoxySeeAlso}{See also} \mbox{\hyperlink{class_qore_1_1zzz8stringzzz9_a07b89a849ef94f060e0fcf2c040fd296}{Qore\+::zzz8stringzzz9\+::get\+Decoded()}} \end{DoxySeeAlso} \mbox{\Hypertarget{group__misc__functions_ga26f2cfc2d0d972642e82eedc09d097cc}\label{group__misc__functions_ga26f2cfc2d0d972642e82eedc09d097cc}} \index{Miscellaneous Functions@{Miscellaneous Functions}!html\_encode@{html\_encode}} \index{html\_encode@{html\_encode}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{html\_encode()}{html\_encode()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} {\footnotesize\ttfamily nothing Qore\+::html\+\_\+encode (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_RUNTIME_NOOP}{RUNTIME\+\_\+\+NOOP}} \end{DoxyParagraph} \mbox{\Hypertarget{group__misc__functions_ga98e1d9690329e8c94f88b833af36ef72}\label{group__misc__functions_ga98e1d9690329e8c94f88b833af36ef72}} \index{Miscellaneous Functions@{Miscellaneous Functions}!html\_encode@{html\_encode}} \index{html\_encode@{html\_encode}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{html\_encode()}{html\_encode()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::html\+\_\+encode (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{str }\end{DoxyParamCaption})} Returns a string with characters needing HTML escaping translated to HTML escape codes. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em str} & the argument to process\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the string passed as an argument with characters needing HTML escaping translated to HTML escape codes \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{string str = \mbox{\hyperlink{group__misc__functions_ga98e1d9690329e8c94f88b833af36ef72}{html\_encode}}(\textcolor{stringliteral}{"{}"{}}); \textcolor{comment}{\# returns "{}\<hello\>"{}}} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyNote}{Note} equivalent to \mbox{\hyperlink{class_qore_1_1zzz8stringzzz9_a4b2cac04c91fb14fcb5a79469550b820}{Qore\+::zzz8stringzzz9\+::get\+Encoded()}} with \mbox{\hyperlink{group___string_concat_encoding_ga7ebe53b7b1a81353a80cc3d79a590db6}{Qore\+::\+CE\+\_\+\+HTML}} \end{DoxyNote} \begin{DoxySeeAlso}{See also} \mbox{\hyperlink{class_qore_1_1zzz8stringzzz9_a4b2cac04c91fb14fcb5a79469550b820}{Qore\+::zzz8stringzzz9\+::get\+Encoded()}} \end{DoxySeeAlso} \mbox{\Hypertarget{group__misc__functions_ga366da9b19ed9b6fb4936f5e5a2ff3663}\label{group__misc__functions_ga366da9b19ed9b6fb4936f5e5a2ff3663}} \index{Miscellaneous Functions@{Miscellaneous Functions}!load\_module@{load\_module}} \index{load\_module@{load\_module}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{load\_module()}{load\_module()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} {\footnotesize\ttfamily nothing Qore\+::load\+\_\+module (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \begin{DoxyParagraph}{Restrictions\+:} \mbox{\hyperlink{group__parse__options_gaccf9af08f7acb25e66b777dcb4c4563b}{Qore\+::\+PO\+\_\+\+NO\+\_\+\+MODULES}} \end{DoxyParagraph} \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_RUNTIME_NOOP}{RUNTIME\+\_\+\+NOOP}} \end{DoxyParagraph} \mbox{\Hypertarget{group__misc__functions_gaf0922a51e6c5471b02a947cb0cb008ba}\label{group__misc__functions_gaf0922a51e6c5471b02a947cb0cb008ba}} \index{Miscellaneous Functions@{Miscellaneous Functions}!load\_module@{load\_module}} \index{load\_module@{load\_module}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{load\_module()}{load\_module()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} {\footnotesize\ttfamily nothing Qore\+::load\+\_\+module (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{name, }\item[{\mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}}}]{warning\+\_\+mask = {\ttfamily \mbox{\hyperlink{group__warning__constants_ga7f704aa8f7652702d72d22ce93125566}{WARN\+\_\+\+MODULES}}} }\end{DoxyParamCaption})} Loads in a Qore module at run-\/time. If a feature with the same name already exists, then this feature\textquotesingle{}s code is imported into the current \mbox{\hyperlink{class_qore_1_1_program}{Program}} object if necessary and no further action is taken. Note that modules providing objects resolved at parse time (classes, constants, functions, etc) must be loaded with the \mbox{\hyperlink{parse_directives_requires}{\%requires directive}} instead, unless all references to the objects provided by the module will be made in code embedded in child \mbox{\hyperlink{class_qore_1_1_program}{Program}} objects. \begin{DoxyParagraph}{Restrictions\+:} \mbox{\hyperlink{group__parse__options_gaccf9af08f7acb25e66b777dcb4c4563b}{Qore\+::\+PO\+\_\+\+NO\+\_\+\+MODULES}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em name} & either a feature name (a module will be searched with this feature name) or a path to a module to load \\ \hline {\em warning\+\_\+mask} & the warning mask to use when loading the module; note that warnings are treated as errors\\ \hline \end{DoxyParams} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{\mbox{\hyperlink{group__misc__functions_gaf0922a51e6c5471b02a947cb0cb008ba}{load\_module}}(\textcolor{stringliteral}{"{}mysql"{}});} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyExceptions}{Exceptions} {\em LOAD-\/\+MODULE-\/\+ERROR} & module cannot be loaded\+: API incompatibility, module defines symbols already defined in the target object, etc\\ \hline \end{DoxyExceptions} \begin{DoxySeeAlso}{See also} \begin{DoxyItemize} \item \mbox{\hyperlink{group__misc__functions_gab64b871ddf6f09568d4a0798c0ca755a}{get\+\_\+module\+\_\+hash()}} \item \mbox{\hyperlink{group__misc__functions_ga86de08439e084c19460ae57d3d6269e5}{get\+\_\+feature\+\_\+list()}} \end{DoxyItemize} \end{DoxySeeAlso} \begin{DoxySince}{Since} \begin{DoxyItemize} \item Qore 0.\+8.\+7 this function can also be used in user module code \item Qore 0.\+9 added the {\ttfamily warning\+\_\+mask} parameter \end{DoxyItemize} \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_ga24b04239fa5f45bd1c3d430dfab49019}\label{group__misc__functions_ga24b04239fa5f45bd1c3d430dfab49019}} \index{Miscellaneous Functions@{Miscellaneous Functions}!load\_module\_warn@{load\_module\_warn}} \index{load\_module\_warn@{load\_module\_warn}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{load\_module\_warn()}{load\_module\_warn()}} {\footnotesize\ttfamily \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$\mbox{\hyperlink{struct_qore_1_1_exception_info}{Exception\+Info}}$>$ Qore\+::load\+\_\+module\+\_\+warn (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{name, }\item[{\mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}}}]{warning\+\_\+mask = {\ttfamily \mbox{\hyperlink{group__warning__constants_ga7f704aa8f7652702d72d22ce93125566}{WARN\+\_\+\+MODULES}}} }\end{DoxyParamCaption})} Loads in a Qore module at run-\/time. If a feature with the same name already exists, then this feature\textquotesingle{}s code is imported into the current \mbox{\hyperlink{class_qore_1_1_program}{Program}} object if necessary and no further action is taken. Note that modules providing objects resolved at parse time (classes, constants, functions, etc) must be loaded with the \mbox{\hyperlink{parse_directives_requires}{\%requires directive}} instead, unless all references to the objects provided by the module will be made in code embedded in child \mbox{\hyperlink{class_qore_1_1_program}{Program}} objects. \begin{DoxyParagraph}{Restrictions\+:} \mbox{\hyperlink{group__parse__options_gaccf9af08f7acb25e66b777dcb4c4563b}{Qore\+::\+PO\+\_\+\+NO\+\_\+\+MODULES}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em name} & either a feature name (a module will be searched with this feature name) or a path to a module to load \\ \hline {\em warning\+\_\+mask} & the warning mask to use when loading the module; note that warnings are treated as errors\\ \hline \end{DoxyParams} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{\mbox{\hyperlink{group__misc__functions_gaf0922a51e6c5471b02a947cb0cb008ba}{load\_module}}(\textcolor{stringliteral}{"{}mysql"{}});} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyExceptions}{Exceptions} {\em LOAD-\/\+MODULE-\/\+ERROR} & module cannot be loaded\+: API incompatibility, module defines symbols already defined in the target object, etc\\ \hline \end{DoxyExceptions} \begin{DoxySeeAlso}{See also} \begin{DoxyItemize} \item \mbox{\hyperlink{group__misc__functions_gab64b871ddf6f09568d4a0798c0ca755a}{get\+\_\+module\+\_\+hash()}} \item \mbox{\hyperlink{group__misc__functions_ga86de08439e084c19460ae57d3d6269e5}{get\+\_\+feature\+\_\+list()}} \end{DoxyItemize} \end{DoxySeeAlso} \begin{DoxySince}{Since} \begin{DoxyItemize} \item Qore 0.\+8.\+7 this function can also be used in user module code \item Qore 0.\+9 added the {\ttfamily warning\+\_\+mask} parameter \end{DoxyItemize} \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_ga59d94b7cc4dfcc6e39030097458b8afe}\label{group__misc__functions_ga59d94b7cc4dfcc6e39030097458b8afe}} \index{Miscellaneous Functions@{Miscellaneous Functions}!load\_user\_module\_with\_program@{load\_user\_module\_with\_program}} \index{load\_user\_module\_with\_program@{load\_user\_module\_with\_program}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{load\_user\_module\_with\_program()}{load\_user\_module\_with\_program()}} {\footnotesize\ttfamily nothing Qore\+::load\+\_\+user\+\_\+module\+\_\+with\+\_\+program (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{name, }\item[{\mbox{\hyperlink{class_qore_1_1_program}{Qore\+::\+Program}}}]{pgm }\end{DoxyParamCaption})} Loads in a Qore user module at run-\/time with using the given \mbox{\hyperlink{class_qore_1_1_program}{Program}} object as the container for the user module code. This function allows a user module to be loaded with a custom API already present in the user module\textquotesingle{}s \mbox{\hyperlink{class_qore_1_1_program}{Program}} container \begin{DoxyParagraph}{Restrictions\+:} \mbox{\hyperlink{group__parse__options_gaccf9af08f7acb25e66b777dcb4c4563b}{Qore\+::\+PO\+\_\+\+NO\+\_\+\+MODULES}} \end{DoxyParagraph} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{\mbox{\hyperlink{group__misc__functions_ga59d94b7cc4dfcc6e39030097458b8afe}{load\_user\_module\_with\_program}}(\textcolor{stringliteral}{"{}MyModule"{}}, p);} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em name} & the name or path of the user module to load \\ \hline {\em pgm} & the \mbox{\hyperlink{class_qore_1_1_program}{Program}} object to use as a container for the new user module, presumably this has a custom API that the user module can use; note that after this call the \mbox{\hyperlink{class_qore_1_1_program}{Program}} object will be owned by the user module, therefore the object itself will no longer be valid and any accesses to the object after this call will result in an exception\\ \hline \end{DoxyParams} \begin{DoxyExceptions}{Exceptions} {\em LOAD-\/\+MODULE-\/\+ERROR} & module cannot be loaded\+: binary modules cannot be loaded in \mbox{\hyperlink{class_qore_1_1_program}{Program}} containers, module defines symbols already defined in the target object, etc\\ \hline \end{DoxyExceptions} \begin{DoxySince}{Since} Qore 0.\+8.\+12 \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_gaba5bd6118895a5f84c03c6a82968a37f}\label{group__misc__functions_gaba5bd6118895a5f84c03c6a82968a37f}} \index{Miscellaneous Functions@{Miscellaneous Functions}!make\_base64\_string@{make\_base64\_string}} \index{make\_base64\_string@{make\_base64\_string}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{make\_base64\_string()}{make\_base64\_string()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::make\+\_\+base64\+\_\+string (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}}}]{bin, }\item[{softint}]{maxlinelen = {\ttfamily -\/1} }\end{DoxyParamCaption})} Returns a base64-\/encoded representation of a binary object. Implementation based on \href{http://www.ietf.org/rfc/rfc1421.txt}{\texttt{ RFC-\/1421}} and \href{http://www.ietf.org/rfc/rfc2045.txt}{\texttt{ RFC-\/2045}} \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em bin} & the data to encode \\ \hline {\em maxlinelen} & the maximum length of a line in the resulting output string in bytes; if this value is $>$ 0 then output lines will be separated by CRLF characters\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the base64-\/encoded string of the data passed \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{string base64 = \mbox{\hyperlink{group__misc__functions_ga8de429a31ac854f93c8c66e14baaaf66}{make\_base64\_string}}(data, 64);} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxySeeAlso}{See also} \begin{DoxyItemize} \item \mbox{\hyperlink{class_qore_1_1zzz8binaryzzz9_ab30735fae927ea3be3e3a710574ff486}{Qore\+::zzz8binaryzzz9\+::to\+Base64()}} \item \mbox{\hyperlink{group__misc__functions_gabc590f8b24ce809f2e5caa7b3ab7ed19}{make\+\_\+hex\+\_\+string(binary)}} \end{DoxyItemize} \end{DoxySeeAlso} \begin{DoxySince}{Since} Qore 0.\+8.\+12 as a replacement for deprecated camel-\/case \mbox{\hyperlink{group__misc__functions_ga302de285f031c3dd4b059df3494bd21c}{make\+Base64\+String()}} \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_ga8de429a31ac854f93c8c66e14baaaf66}\label{group__misc__functions_ga8de429a31ac854f93c8c66e14baaaf66}} \index{Miscellaneous Functions@{Miscellaneous Functions}!make\_base64\_string@{make\_base64\_string}} \index{make\_base64\_string@{make\_base64\_string}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{make\_base64\_string()}{make\_base64\_string()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::make\+\_\+base64\+\_\+string (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{str, }\item[{softint}]{maxlinelen = {\ttfamily -\/1} }\end{DoxyParamCaption})} Returns a base64-\/encoded representation of a string. Implementation based on \href{http://www.ietf.org/rfc/rfc1421.txt}{\texttt{ RFC-\/1421}} and \href{http://www.ietf.org/rfc/rfc2045.txt}{\texttt{ RFC-\/2045}} \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em str} & the string to encode \\ \hline {\em maxlinelen} & the maximum length of a line in the resulting output string in bytes; if this value is $>$ 0 then output lines will be separated by CRLF characters\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the base64-\/encoded string of the data passed \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{string base64 = \mbox{\hyperlink{group__misc__functions_ga8de429a31ac854f93c8c66e14baaaf66}{make\_base64\_string}}(data, 64);} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxySeeAlso}{See also} \begin{DoxyItemize} \item \mbox{\hyperlink{class_qore_1_1zzz8stringzzz9_a13b13f9681a94272d0e16371d2f22d90}{Qore\+::zzz8stringzzz9\+::to\+Base64()}} \item \mbox{\hyperlink{group__misc__functions_gae7be18717b0ed9010c48166a437c35b4}{make\+\_\+hex\+\_\+string(string)}} \end{DoxyItemize} \end{DoxySeeAlso} \begin{DoxySince}{Since} Qore 0.\+8.\+12 as a replacement for deprecated camel-\/case \mbox{\hyperlink{group__misc__functions_ga302de285f031c3dd4b059df3494bd21c}{make\+Base64\+String()}} \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_gabc590f8b24ce809f2e5caa7b3ab7ed19}\label{group__misc__functions_gabc590f8b24ce809f2e5caa7b3ab7ed19}} \index{Miscellaneous Functions@{Miscellaneous Functions}!make\_hex\_string@{make\_hex\_string}} \index{make\_hex\_string@{make\_hex\_string}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{make\_hex\_string()}{make\_hex\_string()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::make\+\_\+hex\+\_\+string (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}}}]{bin }\end{DoxyParamCaption})} Returns a hex-\/encoded representation of a binary object. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em bin} & the binary object to encode\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} a string of hex digits repsenting the bytes of the argument passed \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{string str = \mbox{\hyperlink{group__misc__functions_gae7be18717b0ed9010c48166a437c35b4}{make\_hex\_string}}(bin);} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxySeeAlso}{See also} \begin{DoxyItemize} \item \mbox{\hyperlink{class_qore_1_1zzz8binaryzzz9_ada0665f689a4787b2697c1ff399b7cac}{Qore\+::zzz8binaryzzz9\+::to\+Hex()}} \item \mbox{\hyperlink{group__misc__functions_gaba5bd6118895a5f84c03c6a82968a37f}{make\+\_\+base64\+\_\+string(binary, softint)}} \item \mbox{\hyperlink{group__misc__functions_gaedf4a2c140fa284c9e09a68b743763b3}{parse\+\_\+hex\+\_\+string()}} \end{DoxyItemize} \end{DoxySeeAlso} \begin{DoxySince}{Since} Qore 0.\+8.\+12 as a replacement for deprecated camel-\/case \mbox{\hyperlink{group__misc__functions_gae4ca24e1000d327df636f75c7bf4f00c}{make\+Hex\+String()}} \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_gae7be18717b0ed9010c48166a437c35b4}\label{group__misc__functions_gae7be18717b0ed9010c48166a437c35b4}} \index{Miscellaneous Functions@{Miscellaneous Functions}!make\_hex\_string@{make\_hex\_string}} \index{make\_hex\_string@{make\_hex\_string}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{make\_hex\_string()}{make\_hex\_string()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::make\+\_\+hex\+\_\+string (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{str }\end{DoxyParamCaption})} Returns a hex-\/encoded representation of a string. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em str} & the string to encode\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} a string of hex digits repsenting the bytes of the argument passed \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{string str = \mbox{\hyperlink{group__misc__functions_gae7be18717b0ed9010c48166a437c35b4}{make\_hex\_string}}(str2);} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxySeeAlso}{See also} \begin{DoxyItemize} \item \mbox{\hyperlink{class_qore_1_1zzz8binaryzzz9_ada0665f689a4787b2697c1ff399b7cac}{Qore\+::zzz8binaryzzz9\+::to\+Hex()}} \item \mbox{\hyperlink{group__misc__functions_gaba5bd6118895a5f84c03c6a82968a37f}{make\+\_\+base64\+\_\+string(binary, softint)}} \item \mbox{\hyperlink{group__misc__functions_gaedf4a2c140fa284c9e09a68b743763b3}{parse\+\_\+hex\+\_\+string()}} \end{DoxyItemize} \end{DoxySeeAlso} \begin{DoxySince}{Since} Qore 0.\+8.\+12 as a replacement for deprecated camel-\/case \mbox{\hyperlink{group__misc__functions_gae4ca24e1000d327df636f75c7bf4f00c}{make\+Hex\+String()}} \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_ga1d5d34fd58d766f2eacde5701f5a99ae}\label{group__misc__functions_ga1d5d34fd58d766f2eacde5701f5a99ae}} \index{Miscellaneous Functions@{Miscellaneous Functions}!makeBase64String@{makeBase64String}} \index{makeBase64String@{makeBase64String}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{makeBase64String()}{makeBase64String()}\hspace{0.1cm}{\footnotesize\ttfamily [1/3]}} {\footnotesize\ttfamily nothing Qore\+::make\+Base64\+String (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_RUNTIME_NOOP}{RUNTIME\+\_\+\+NOOP}}, \mbox{\hyperlink{code_flags_DEPRECATED}{DEPRECATED}} \end{DoxyParagraph} \mbox{\Hypertarget{group__misc__functions_ga511ce458d13dfbea8c22ece63c315bb7}\label{group__misc__functions_ga511ce458d13dfbea8c22ece63c315bb7}} \index{Miscellaneous Functions@{Miscellaneous Functions}!makeBase64String@{makeBase64String}} \index{makeBase64String@{makeBase64String}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{makeBase64String()}{makeBase64String()}\hspace{0.1cm}{\footnotesize\ttfamily [2/3]}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::make\+Base64\+String (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}}}]{bin, }\item[{softint}]{maxlinelen = {\ttfamily -\/1} }\end{DoxyParamCaption})} Returns a base64-\/encoded representation of a binary object. Implementation based on \href{http://www.ietf.org/rfc/rfc1421.txt}{\texttt{ RFC-\/1421}} and \href{http://www.ietf.org/rfc/rfc2045.txt}{\texttt{ RFC-\/2045}} \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}}, \mbox{\hyperlink{code_flags_DEPRECATED}{DEPRECATED}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em bin} & the data to encode \\ \hline {\em maxlinelen} & the maximum length of a line in the resulting output string in bytes; if this value is $>$ 0 then output lines will be separated by CRLF characters\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the base64-\/encoded string of the data passed \end{DoxyReturn} \begin{DoxySince}{Since} the maxlinelen parameter was added in Qore 0.\+8.\+4 \end{DoxySince} \begin{DoxySeeAlso}{See also} \begin{DoxyItemize} \item \mbox{\hyperlink{class_qore_1_1zzz8binaryzzz9_ab30735fae927ea3be3e3a710574ff486}{Qore\+::zzz8binaryzzz9\+::to\+Base64()}} \item \mbox{\hyperlink{group__misc__functions_gabc590f8b24ce809f2e5caa7b3ab7ed19}{make\+\_\+hex\+\_\+string(binary)}} \end{DoxyItemize} \end{DoxySeeAlso} \begin{DoxyRefDesc}{Deprecated} \item[\mbox{\hyperlink{deprecated__deprecated000027}{Deprecated}}]use \mbox{\hyperlink{group__misc__functions_ga8de429a31ac854f93c8c66e14baaaf66}{make\+\_\+base64\+\_\+string()}}; camel-\/case function names were deprecated in Qore 0.\+8.\+12 \end{DoxyRefDesc} \mbox{\Hypertarget{group__misc__functions_ga302de285f031c3dd4b059df3494bd21c}\label{group__misc__functions_ga302de285f031c3dd4b059df3494bd21c}} \index{Miscellaneous Functions@{Miscellaneous Functions}!makeBase64String@{makeBase64String}} \index{makeBase64String@{makeBase64String}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{makeBase64String()}{makeBase64String()}\hspace{0.1cm}{\footnotesize\ttfamily [3/3]}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::make\+Base64\+String (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{str, }\item[{softint}]{maxlinelen = {\ttfamily -\/1} }\end{DoxyParamCaption})} Returns a base64-\/encoded representation of a string. Implementation based on \href{http://www.ietf.org/rfc/rfc1421.txt}{\texttt{ RFC-\/1421}} and \href{http://www.ietf.org/rfc/rfc2045.txt}{\texttt{ RFC-\/2045}} \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}}, \mbox{\hyperlink{code_flags_DEPRECATED}{DEPRECATED}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em str} & the string to encode \\ \hline {\em maxlinelen} & the maximum length of a line in the resulting output string in bytes; if this value is $>$ 0 then output lines will be separated by CRLF characters\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the base64-\/encoded string of the data passed \end{DoxyReturn} \begin{DoxySince}{Since} the maxlinelen parameter was added in Qore 0.\+8.\+4 \end{DoxySince} \begin{DoxySeeAlso}{See also} \begin{DoxyItemize} \item \mbox{\hyperlink{class_qore_1_1zzz8stringzzz9_a13b13f9681a94272d0e16371d2f22d90}{Qore\+::zzz8stringzzz9\+::to\+Base64()}} \item \mbox{\hyperlink{group__misc__functions_gae7be18717b0ed9010c48166a437c35b4}{make\+\_\+hex\+\_\+string(string)}} \end{DoxyItemize} \end{DoxySeeAlso} \begin{DoxyRefDesc}{Deprecated} \item[\mbox{\hyperlink{deprecated__deprecated000026}{Deprecated}}]use \mbox{\hyperlink{group__misc__functions_ga8de429a31ac854f93c8c66e14baaaf66}{make\+\_\+base64\+\_\+string()}}; camel-\/case function names were deprecated in Qore 0.\+8.\+12 \end{DoxyRefDesc} \mbox{\Hypertarget{group__misc__functions_gacb04ca5bd37d873b867186c4da295f0c}\label{group__misc__functions_gacb04ca5bd37d873b867186c4da295f0c}} \index{Miscellaneous Functions@{Miscellaneous Functions}!makeHexString@{makeHexString}} \index{makeHexString@{makeHexString}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{makeHexString()}{makeHexString()}\hspace{0.1cm}{\footnotesize\ttfamily [1/3]}} {\footnotesize\ttfamily nothing Qore\+::make\+Hex\+String (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_RUNTIME_NOOP}{RUNTIME\+\_\+\+NOOP}}, \mbox{\hyperlink{code_flags_DEPRECATED}{DEPRECATED}} \end{DoxyParagraph} \mbox{\Hypertarget{group__misc__functions_gaafe286db27d58cea75749c1bdabb5ad0}\label{group__misc__functions_gaafe286db27d58cea75749c1bdabb5ad0}} \index{Miscellaneous Functions@{Miscellaneous Functions}!makeHexString@{makeHexString}} \index{makeHexString@{makeHexString}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{makeHexString()}{makeHexString()}\hspace{0.1cm}{\footnotesize\ttfamily [2/3]}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::make\+Hex\+String (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}}}]{bin }\end{DoxyParamCaption})} Returns a hex-\/encoded representation of a binary object. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}}, \mbox{\hyperlink{code_flags_DEPRECATED}{DEPRECATED}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em bin} & the binary object to encode\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} a string of hex digits repsenting the bytes of the argument passed \end{DoxyReturn} \begin{DoxySeeAlso}{See also} \begin{DoxyItemize} \item \mbox{\hyperlink{class_qore_1_1zzz8binaryzzz9_ada0665f689a4787b2697c1ff399b7cac}{Qore\+::zzz8binaryzzz9\+::to\+Hex()}} \item \mbox{\hyperlink{group__misc__functions_ga8de429a31ac854f93c8c66e14baaaf66}{make\+\_\+base64\+\_\+string(string, softint)}} \item \mbox{\hyperlink{group__misc__functions_gaedf4a2c140fa284c9e09a68b743763b3}{parse\+\_\+hex\+\_\+string()}} \end{DoxyItemize} \end{DoxySeeAlso} \begin{DoxyRefDesc}{Deprecated} \item[\mbox{\hyperlink{deprecated__deprecated000029}{Deprecated}}]use \mbox{\hyperlink{group__misc__functions_gae7be18717b0ed9010c48166a437c35b4}{make\+\_\+hex\+\_\+string()}}; camel-\/case function names were deprecated in Qore 0.\+8.\+12 \end{DoxyRefDesc} \mbox{\Hypertarget{group__misc__functions_gae4ca24e1000d327df636f75c7bf4f00c}\label{group__misc__functions_gae4ca24e1000d327df636f75c7bf4f00c}} \index{Miscellaneous Functions@{Miscellaneous Functions}!makeHexString@{makeHexString}} \index{makeHexString@{makeHexString}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{makeHexString()}{makeHexString()}\hspace{0.1cm}{\footnotesize\ttfamily [3/3]}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::make\+Hex\+String (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{str }\end{DoxyParamCaption})} Returns a hex-\/encoded representation of a string. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}}, \mbox{\hyperlink{code_flags_DEPRECATED}{DEPRECATED}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em str} & the string to encode\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} a string of hex digits repsenting the bytes of the argument passed \end{DoxyReturn} \begin{DoxySeeAlso}{See also} \begin{DoxyItemize} \item \mbox{\hyperlink{class_qore_1_1zzz8stringzzz9_af4a4f62237f079383098441132967527}{Qore\+::zzz8stringzzz9\+::to\+Hex()}} \item \mbox{\hyperlink{group__misc__functions_ga8de429a31ac854f93c8c66e14baaaf66}{make\+\_\+base64\+\_\+string(string, softint)}} \item \mbox{\hyperlink{group__misc__functions_gaedf4a2c140fa284c9e09a68b743763b3}{parse\+\_\+hex\+\_\+string()}} \end{DoxyItemize} \end{DoxySeeAlso} \begin{DoxyRefDesc}{Deprecated} \item[\mbox{\hyperlink{deprecated__deprecated000028}{Deprecated}}]use \mbox{\hyperlink{group__misc__functions_gae7be18717b0ed9010c48166a437c35b4}{make\+\_\+hex\+\_\+string()}}; camel-\/case function names were deprecated in Qore 0.\+8.\+12 \end{DoxyRefDesc} \mbox{\Hypertarget{group__misc__functions_ga6c7d460b97c3c862717b052355985ded}\label{group__misc__functions_ga6c7d460b97c3c862717b052355985ded}} \index{Miscellaneous Functions@{Miscellaneous Functions}!parse@{parse}} \index{parse@{parse}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{parse()}{parse()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} {\footnotesize\ttfamily nothing Qore\+::parse (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \begin{DoxyParagraph}{Restrictions\+:} \mbox{\hyperlink{group__parse__options_gab1337f461ab4a90df9b39a7f1b6cc2b0}{Qore\+::\+PO\+\_\+\+NO\+\_\+\+EMBEDDED\+\_\+\+LOGIC}}, \mbox{\hyperlink{group__parse__options_ga094a2d1f503a2b1e9abbe11b0d47cc6e}{Qore\+::\+PO\+\_\+\+IN\+\_\+\+MODULE}} \end{DoxyParagraph} \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_RUNTIME_NOOP}{RUNTIME\+\_\+\+NOOP}} \end{DoxyParagraph} \mbox{\Hypertarget{group__misc__functions_ga11da5fd06dcfa57a48a5381268a52086}\label{group__misc__functions_ga11da5fd06dcfa57a48a5381268a52086}} \index{Miscellaneous Functions@{Miscellaneous Functions}!parse@{parse}} \index{parse@{parse}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{parse()}{parse()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} {\footnotesize\ttfamily \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$auto$>$ Qore\+::parse (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{code, }\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{label, }\item[{\+\_\+\+\_\+7\+\_\+ softint}]{warning\+\_\+mask, }\item[{\+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{source, }\item[{\+\_\+\+\_\+7\+\_\+ softint}]{offset, }\item[{softbool}]{format\+\_\+label = {\ttfamily \mbox{\hyperlink{group__boolean__constants_ga3ba2df91713a6249449347131ea526c3}{True}}} }\end{DoxyParamCaption})} Adds the text passed to the current program\textquotesingle{}s code, tagged with the given label. \begin{DoxyParagraph}{Restrictions\+:} \mbox{\hyperlink{group__parse__options_gab1337f461ab4a90df9b39a7f1b6cc2b0}{Qore\+::\+PO\+\_\+\+NO\+\_\+\+EMBEDDED\+\_\+\+LOGIC}}, \mbox{\hyperlink{group__parse__options_ga094a2d1f503a2b1e9abbe11b0d47cc6e}{Qore\+::\+PO\+\_\+\+IN\+\_\+\+MODULE}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em code} & the string of Qore source code to parse; the parsed code will be added to the current program \\ \hline {\em label} & a label identifying the code or the code\textquotesingle{}s source \\ \hline {\em warning\+\_\+mask} & An optional warning mask; see \mbox{\hyperlink{group__warning__constants}{Warning Constants}} for values to combine by binary-\/or; if this arguments is 0 or not given then no warnings will be checked or issued and the return value will always be \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} \\ \hline {\em source} & An optional source file name for the code being parsed; this is useful if sections of a file are parsed \\ \hline {\em offset} & An optional line offset for use with the {\itshape source} parameter; this gives the line offset in the file to the code being parsed \\ \hline {\em format\+\_\+label} & Qore 0.\+9 is obsolete / ignored\\ \hline \end{DoxyParams} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{\mbox{\hyperlink{group__misc__functions_ga11da5fd06dcfa57a48a5381268a52086}{parse}}(code, filename);} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyNote}{Note} This function could throw many parse exceptions which are not enumerated here; any parse errors will result in an appropriate exception. \end{DoxyNote} \begin{DoxySeeAlso}{See also} \begin{DoxyItemize} \item \mbox{\hyperlink{class_qore_1_1_program_ad59f1b6ce7adaa693086e1b858cbe896}{Qore\+::\+Program\+::parse()}} \item \mbox{\hyperlink{class_qore_1_1_program_ac943bad226fcf69ce5007b101828f8c1}{Qore\+::\+Program\+::parse\+Pending()}} \end{DoxyItemize} \end{DoxySeeAlso} \begin{DoxySince}{Since} Qore 0.\+8.\+7 the optional {\itshape warning\+\_\+mask}, {\itshape source}, {\itshape offset}, and {\itshape format\+\_\+label} arguments were added; Qore 0.\+9 the {\itshape format\+\_\+label} is obsolete / ignored; these changes were made to align the functionality of this function with the \mbox{\hyperlink{class_qore_1_1_program_ad59f1b6ce7adaa693086e1b858cbe896}{Program\+::parse()}} and \mbox{\hyperlink{class_qore_1_1_program_ac943bad226fcf69ce5007b101828f8c1}{Program\+::parse\+Pending()}} methods \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_ga34c9bccc1d1e61d6a8a8988ceb4a8a6c}\label{group__misc__functions_ga34c9bccc1d1e61d6a8a8988ceb4a8a6c}} \index{Miscellaneous Functions@{Miscellaneous Functions}!parse\_base64\_string@{parse\_base64\_string}} \index{parse\_base64\_string@{parse\_base64\_string}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{parse\_base64\_string()}{parse\_base64\_string()}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}} Qore\+::parse\+\_\+base64\+\_\+string (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{str }\end{DoxyParamCaption})} Parses a base64 encoded string and returns a binary object of the decoded data. Implementation based on \href{http://www.ietf.org/rfc/rfc1421.txt}{\texttt{ RFC-\/1421}} and \href{http://www.ietf.org/rfc/rfc2045.txt}{\texttt{ RFC-\/2045}} \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_RET_VALUE_ONLY}{RET\+\_\+\+VALUE\+\_\+\+ONLY}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em str} & the base64-\/encoded input data to decode\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} a binary object of the decoded data \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{binary bin = \mbox{\hyperlink{group__misc__functions_ga34c9bccc1d1e61d6a8a8988ceb4a8a6c}{parse\_base64\_string}}(base64\_string);} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyExceptions}{Exceptions} {\em BASE64-\/\+PARSE-\/\+ERROR} & A syntax error occurred parsing the base64 string (invalid character, etc)\\ \hline \end{DoxyExceptions} \begin{DoxySeeAlso}{See also} \begin{DoxyItemize} \item \mbox{\hyperlink{group__misc__functions_gaedf4a2c140fa284c9e09a68b743763b3}{parse\+\_\+hex\+\_\+string()}} \item \mbox{\hyperlink{group__misc__functions_ga0160c0c4cbe7180d70048577e4e40bcc}{parse\+\_\+base64\+\_\+string\+\_\+to\+\_\+string()}} \end{DoxyItemize} \end{DoxySeeAlso} \begin{DoxySince}{Since} Qore 0.\+8.\+12 as a replacement for deprecated camel-\/case \mbox{\hyperlink{group__misc__functions_ga1e6e24f780713c4d10cb9b98fa45cd35}{parse\+Base64\+String()}} \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_ga0160c0c4cbe7180d70048577e4e40bcc}\label{group__misc__functions_ga0160c0c4cbe7180d70048577e4e40bcc}} \index{Miscellaneous Functions@{Miscellaneous Functions}!parse\_base64\_string\_to\_string@{parse\_base64\_string\_to\_string}} \index{parse\_base64\_string\_to\_string@{parse\_base64\_string\_to\_string}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{parse\_base64\_string\_to\_string()}{parse\_base64\_string\_to\_string()}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::parse\+\_\+base64\+\_\+string\+\_\+to\+\_\+string (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{str, }\item[{\+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{encoding }\end{DoxyParamCaption})} Parses a base64 encoded string and returns a string of the decoded data. Implementation based on \href{http://www.ietf.org/rfc/rfc1421.txt}{\texttt{ RFC-\/1421}} and \href{http://www.ietf.org/rfc/rfc2045.txt}{\texttt{ RFC-\/2045}} \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_RET_VALUE_ONLY}{RET\+\_\+\+VALUE\+\_\+\+ONLY}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em str} & the base64-\/encoded input data to decode \\ \hline {\em encoding} & the character encoding tag for the string return value; if not present, the \mbox{\hyperlink{character_encoding_default_encoding}{default character encoding}} is assumed.\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} a string of the decoded data tagged with the given encoding \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{string str = \mbox{\hyperlink{group__misc__functions_ga0160c0c4cbe7180d70048577e4e40bcc}{parse\_base64\_string\_to\_string}}(base64\_string);} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyExceptions}{Exceptions} {\em BASE64-\/\+PARSE-\/\+ERROR} & A syntax error occurred parsing the base64 string (invalid character, etc)\\ \hline \end{DoxyExceptions} \begin{DoxySince}{Since} the encoding parameter was added in Qore 0.\+8.\+4 \end{DoxySince} \begin{DoxySeeAlso}{See also} \begin{DoxyItemize} \item \mbox{\hyperlink{group__misc__functions_gaedf4a2c140fa284c9e09a68b743763b3}{parse\+\_\+hex\+\_\+string()}} \item \mbox{\hyperlink{group__misc__functions_ga0160c0c4cbe7180d70048577e4e40bcc}{parse\+\_\+base64\+\_\+string\+\_\+to\+\_\+string()}} \end{DoxyItemize} \end{DoxySeeAlso} \begin{DoxySince}{Since} Qore 0.\+8.\+12 as a replacement for deprecated camel-\/case \mbox{\hyperlink{group__misc__functions_ga1f1a63790a7c60a3a61c5d1569fe4e4c}{parse\+Base64\+String\+To\+String()}} \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_gaedf4a2c140fa284c9e09a68b743763b3}\label{group__misc__functions_gaedf4a2c140fa284c9e09a68b743763b3}} \index{Miscellaneous Functions@{Miscellaneous Functions}!parse\_hex\_string@{parse\_hex\_string}} \index{parse\_hex\_string@{parse\_hex\_string}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{parse\_hex\_string()}{parse\_hex\_string()}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}} Qore\+::parse\+\_\+hex\+\_\+string (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{hexstr }\end{DoxyParamCaption})} Parses a hex-\/encoded string and returns the binary object. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_RET_VALUE_ONLY}{RET\+\_\+\+VALUE\+\_\+\+ONLY}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em hexstr} & a string of an even-\/number of only hexadecimal digits\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} a binary object of the decoded data \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{binary bin = \mbox{\hyperlink{group__misc__functions_ga74fed7603d2176dd5d433d3fae02ad9f}{parseHexString}}(hex\_string);} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyExceptions}{Exceptions} {\em PARSE-\/\+HEX-\/\+ERROR} & A syntax error occurred parsing the hex string (odd number of digits, invalid hex character, etc)\\ \hline \end{DoxyExceptions} \begin{DoxySeeAlso}{See also} \begin{DoxyItemize} \item \mbox{\hyperlink{group__misc__functions_ga34c9bccc1d1e61d6a8a8988ceb4a8a6c}{parse\+\_\+base64\+\_\+string()}} \item \mbox{\hyperlink{group__misc__functions_gae7be18717b0ed9010c48166a437c35b4}{make\+\_\+hex\+\_\+string()}} \end{DoxyItemize} \end{DoxySeeAlso} \begin{DoxySince}{Since} Qore 0.\+8.\+12 as a replacement for deprecated camel-\/case \mbox{\hyperlink{group__misc__functions_ga74fed7603d2176dd5d433d3fae02ad9f}{parse\+Hex\+String()}} \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_gad08ab1d19f1e77fbaa3d1a3d626ee45c}\label{group__misc__functions_gad08ab1d19f1e77fbaa3d1a3d626ee45c}} \index{Miscellaneous Functions@{Miscellaneous Functions}!parse\_url@{parse\_url}} \index{parse\_url@{parse\_url}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{parse\_url()}{parse\_url()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$\mbox{\hyperlink{struct_qore_1_1_url_info}{Url\+Info}}$>$ Qore\+::parse\+\_\+url (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{url, }\item[{\+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}}}]{options }\end{DoxyParamCaption})} Parses a URL string and returns a hash of the components. Throws an exception if the string cannot be parsed as a URL \begin{DoxyParams}{Parameters} {\em url} & the URL to parse (ex\+: {\ttfamily \char`\"{}https\+://user\+:pass@host\+:8080/path\char`\"{}}); either a hostname or path is required at a minimum or a {\ttfamily PARSE-\/\+URL-\/\+ERROR} exception is raised \\ \hline {\em options} & a bitfield of \mbox{\hyperlink{group__parse__url__options}{URL Parsing Options}}\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} a hash of the components of the URL with the following keys (if data in the URL is present; note that at least either the {\ttfamily \char`\"{}host\char`\"{}} or the {\ttfamily \char`\"{}path\char`\"{}} keys will always be returned if no {\ttfamily PARSE-\/\+URL-\/\+ERROR} is raised)\+: \begin{DoxyItemize} \item {\ttfamily protocol\+:} the scheme in the URL (ex\+: {\ttfamily \char`\"{}http\char`\"{}}) \item {\ttfamily path\+:} any path given in the URL; the path will be prefixed by {\ttfamily \char`\"{}/\char`\"{}} if a hostname is found in the URL argument string, otherwise it will not if it was not given as such in the argument string; subject to percent decoding if \mbox{\hyperlink{group__parse__url__options_ga8c41e16cce13b426c12c9e28f0cb7b29}{QURL\+\_\+\+DECODE}} passed in {\itshape options} \item {\ttfamily query\+:} any query component of the URL (i.\+e. text after any {\ttfamily \textquotesingle{}}?\textquotesingle{} character); only present if the QRUL\+\_\+\+QUERY argument is present in {\itshape options}; subject to percent decoding if \mbox{\hyperlink{group__parse__url__options_ga8c41e16cce13b426c12c9e28f0cb7b29}{QURL\+\_\+\+DECODE}} passed in {\itshape options} \item {\ttfamily username\+:} any username given in the URL; subject to percent decoding if \mbox{\hyperlink{group__parse__url__options_ga8c41e16cce13b426c12c9e28f0cb7b29}{QURL\+\_\+\+DECODE}} or \mbox{\hyperlink{group__parse__url__options_gad653e5829af0534c19a3873905cc74d9}{QURL\+\_\+\+DECODE\+\_\+\+PATH}} passed in {\itshape options} \item {\ttfamily password\+:} any password given in the URL; subject to percent decoding if \mbox{\hyperlink{group__parse__url__options_ga8c41e16cce13b426c12c9e28f0cb7b29}{QURL\+\_\+\+DECODE}} or \mbox{\hyperlink{group__parse__url__options_gad653e5829af0534c19a3873905cc74d9}{QURL\+\_\+\+DECODE\+\_\+\+PATH}} passed in {\itshape options} \item {\ttfamily host\+:} any hostname given in the URL; note that this key will be given if no other information can be found in the URL argument and the URL argument string has no {\ttfamily \char`\"{}/\char`\"{}} characters; depending on the usage context for this function, this may actually be a filename; subject to percent decoding if \mbox{\hyperlink{group__parse__url__options_ga8c41e16cce13b426c12c9e28f0cb7b29}{QURL\+\_\+\+DECODE}} or \mbox{\hyperlink{group__parse__url__options_gad653e5829af0534c19a3873905cc74d9}{QURL\+\_\+\+DECODE\+\_\+\+PATH}} passed in {\itshape options} \item {\ttfamily port\+:} any port number given in the URL \end{DoxyItemize} \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{hash h = \mbox{\hyperlink{group__misc__functions_ga4e22308b56f16f8bd090e69ed3bad451}{parse\_url}}(url\_string, QURL\_DECODE);} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyExceptions}{Exceptions} {\em PARSE-\/\+URL-\/\+ERROR} & The URL string given could not be parsed\\ \hline \end{DoxyExceptions} \begin{DoxyNote}{Note} \begin{DoxyItemize} \item URLs with UNIX sockets are generally supported in \mbox{\hyperlink{namespace_qore}{Qore}} with the following syntax\+: {\ttfamily {\bfseries{scheme\+://socket=}}}{\itshape url\+\_\+encoded\+\_\+path}{\ttfamily {\bfseries{/path}}}, where {\itshape url\+\_\+encoded\+\_\+path} is a path with URL-\/encoding as performed by \mbox{\hyperlink{group__misc__functions_ga639fba8c278c69ac4d4190ca1db19235}{encode\+\_\+url(string, True)}}; for example\+: {\ttfamily \char`\"{}http\+://socket=\%2ftmp\%socket-\/dir\%2fsocket-\/file-\/1/url/path\char`\"{}}; this allows a filesystem path to be used in the host portion of the URL and for the URL to include a URL path as well. \end{DoxyItemize} \end{DoxyNote} \begin{DoxySeeAlso}{See also} \begin{DoxyItemize} \item \mbox{\hyperlink{group__misc__functions_gae1961be84af7e6bc5553049bf978f922}{parse\+URL()}} for a version of this function that does not throw exceptions if the URL cannot be parsed \end{DoxyItemize} \end{DoxySeeAlso} \mbox{\Hypertarget{group__misc__functions_ga4e22308b56f16f8bd090e69ed3bad451}\label{group__misc__functions_ga4e22308b56f16f8bd090e69ed3bad451}} \index{Miscellaneous Functions@{Miscellaneous Functions}!parse\_url@{parse\_url}} \index{parse\_url@{parse\_url}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{parse\_url()}{parse\_url()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$\mbox{\hyperlink{struct_qore_1_1_url_info}{Url\+Info}}$>$ Qore\+::parse\+\_\+url (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{url, }\item[{bool}]{keep\+\_\+brackets }\end{DoxyParamCaption})} Parses a URL string and returns a hash of the components. Throws an exception if the string cannot be parsed as a URL; does not perform percent decoding \begin{DoxyParams}{Parameters} {\em url} & the URL to parse (ex\+: {\ttfamily \char`\"{}https\+://user\+:pass@host\+:8080/path\char`\"{}}); either a hostname or path is required at a minimum or a {\ttfamily PARSE-\/\+URL-\/\+ERROR} exception is raised \\ \hline {\em keep\+\_\+brackets} & if this argument is true then if the hostname or address is enclosed in square brackets, then the brackets will be included in the {\ttfamily \char`\"{}host\char`\"{}} key output as well; square brackets are used by some Qore methods to denote IPv6 addresses; for example see \mbox{\hyperlink{class_qore_1_1_socket_a7e0dc386a95c3c6a0e1cc12269d4374b}{Socket\+::connect()}}\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} a hash of the components of the URL with the following keys (if data in the URL is present; note that at least either the {\ttfamily \char`\"{}host\char`\"{}} or the {\ttfamily \char`\"{}path\char`\"{}} keys will always be returned if no {\ttfamily PARSE-\/\+URL-\/\+ERROR} is raised)\+: \begin{DoxyItemize} \item {\ttfamily protocol\+:} the scheme in the URL (ex\+: {\ttfamily \char`\"{}http\char`\"{}}) \item {\ttfamily path\+:} any path given in the URL; the path will be prefixed by {\ttfamily \char`\"{}/\char`\"{}} if a hostname is found in the URL argument string, otherwise it will not if it was not given as such in the argument string -\/ not subjected to percent decoding (see note below) \item {\ttfamily username\+:} any username given in the URL -\/ not subjected to percent decoding (see note below) \item {\ttfamily password\+:} any password given in the URL -\/ not subjected to percent decoding (see note below) \item {\ttfamily host\+:} any hostname given in the URL; note that this key will be given if no other information can be found in the URL argument and the URL argument string has no {\ttfamily \char`\"{}/\char`\"{}} characters; depending on the usage context for this function, this may actually be a filename \item {\ttfamily port\+:} any port number given in the URL \end{DoxyItemize} \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{hash h = \mbox{\hyperlink{group__misc__functions_ga4e22308b56f16f8bd090e69ed3bad451}{parse\_url}}(url\_string, \textcolor{keyword}{True});} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyExceptions}{Exceptions} {\em PARSE-\/\+URL-\/\+ERROR} & The URL string given could not be parsed\\ \hline \end{DoxyExceptions} \begin{DoxyNote}{Note} \begin{DoxyItemize} \item URLs with UNIX sockets are generally supported in \mbox{\hyperlink{namespace_qore}{Qore}} with the following syntax\+: {\ttfamily {\bfseries{scheme\+://socket=}}}{\itshape url\+\_\+encoded\+\_\+path}{\ttfamily {\bfseries{/path}}}, where {\itshape url\+\_\+encoded\+\_\+path} is a path with URL-\/encoding as performed by \mbox{\hyperlink{group__misc__functions_ga639fba8c278c69ac4d4190ca1db19235}{encode\+\_\+url(string, True)}}; for example\+: {\ttfamily \char`\"{}http\+://socket=\%2ftmp\%socket-\/dir\%2fsocket-\/file-\/1/url/path\char`\"{}}; this allows a filesystem path to be used in the host portion of the URL and for the URL to include a URL path as well. \item none of the string fields returned here are subjected to percent decoding; to decode percent encoding, call \mbox{\hyperlink{group__misc__functions_ga51b949c2d20900fdc2e1b8e46988d2b1}{decode\+\_\+url()}} on the strings manually or use the \mbox{\hyperlink{group__misc__functions_gad08ab1d19f1e77fbaa3d1a3d626ee45c}{parse\+\_\+url(string, \+\_\+\+\_\+7\+\_\+ int)}} variant with the \mbox{\hyperlink{group__parse__url__options_ga8c41e16cce13b426c12c9e28f0cb7b29}{QURL\+\_\+\+DECODE}} or \mbox{\hyperlink{group__parse__url__options_gad653e5829af0534c19a3873905cc74d9}{QURL\+\_\+\+DECODE\+\_\+\+PATH}} option \end{DoxyItemize} \end{DoxyNote} \begin{DoxySeeAlso}{See also} \mbox{\hyperlink{group__misc__functions_gae1961be84af7e6bc5553049bf978f922}{parse\+URL()}} for a version of this function that does not throw exceptions if the URL cannot be parsed \end{DoxySeeAlso} \mbox{\Hypertarget{group__misc__functions_ga0c3bdfd8fb3a29af0d3bcd0ed3a05eb0}\label{group__misc__functions_ga0c3bdfd8fb3a29af0d3bcd0ed3a05eb0}} \index{Miscellaneous Functions@{Miscellaneous Functions}!parseBase64String@{parseBase64String}} \index{parseBase64String@{parseBase64String}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{parseBase64String()}{parseBase64String()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} {\footnotesize\ttfamily nothing Qore\+::parse\+Base64\+String (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_RUNTIME_NOOP}{RUNTIME\+\_\+\+NOOP}}, \mbox{\hyperlink{code_flags_DEPRECATED}{DEPRECATED}} \end{DoxyParagraph} \mbox{\Hypertarget{group__misc__functions_ga1e6e24f780713c4d10cb9b98fa45cd35}\label{group__misc__functions_ga1e6e24f780713c4d10cb9b98fa45cd35}} \index{Miscellaneous Functions@{Miscellaneous Functions}!parseBase64String@{parseBase64String}} \index{parseBase64String@{parseBase64String}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{parseBase64String()}{parseBase64String()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}} Qore\+::parse\+Base64\+String (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{str }\end{DoxyParamCaption})} Parses a base64 encoded string and returns a binary object of the decoded data. Implementation based on \href{http://www.ietf.org/rfc/rfc1421.txt}{\texttt{ RFC-\/1421}} and \href{http://www.ietf.org/rfc/rfc2045.txt}{\texttt{ RFC-\/2045}} \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_RET_VALUE_ONLY}{RET\+\_\+\+VALUE\+\_\+\+ONLY}}, \mbox{\hyperlink{code_flags_DEPRECATED}{DEPRECATED}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em str} & the base64-\/encoded input data to decode\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} a binary object of the decoded data \end{DoxyReturn} \begin{DoxyExceptions}{Exceptions} {\em BASE64-\/\+PARSE-\/\+ERROR} & A syntax error occurred parsing the base64 string (invalid character, etc)\\ \hline \end{DoxyExceptions} \begin{DoxySeeAlso}{See also} \begin{DoxyItemize} \item \mbox{\hyperlink{group__misc__functions_gaedf4a2c140fa284c9e09a68b743763b3}{parse\+\_\+hex\+\_\+string()}} \item \mbox{\hyperlink{group__misc__functions_ga0160c0c4cbe7180d70048577e4e40bcc}{parse\+\_\+base64\+\_\+string\+\_\+to\+\_\+string()}} \end{DoxyItemize} \end{DoxySeeAlso} \begin{DoxyRefDesc}{Deprecated} \item[\mbox{\hyperlink{deprecated__deprecated000030}{Deprecated}}]use \mbox{\hyperlink{group__misc__functions_ga34c9bccc1d1e61d6a8a8988ceb4a8a6c}{parse\+\_\+base64\+\_\+string()}}; camel-\/case function names were deprecated in Qore 0.\+8.\+12 \end{DoxyRefDesc} \mbox{\Hypertarget{group__misc__functions_ga8851e308445e0388408b8b2cca344088}\label{group__misc__functions_ga8851e308445e0388408b8b2cca344088}} \index{Miscellaneous Functions@{Miscellaneous Functions}!parseBase64StringToString@{parseBase64StringToString}} \index{parseBase64StringToString@{parseBase64StringToString}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{parseBase64StringToString()}{parseBase64StringToString()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} {\footnotesize\ttfamily nothing Qore\+::parse\+Base64\+String\+To\+String (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_RUNTIME_NOOP}{RUNTIME\+\_\+\+NOOP}}, \mbox{\hyperlink{code_flags_DEPRECATED}{DEPRECATED}} \end{DoxyParagraph} \mbox{\Hypertarget{group__misc__functions_ga1f1a63790a7c60a3a61c5d1569fe4e4c}\label{group__misc__functions_ga1f1a63790a7c60a3a61c5d1569fe4e4c}} \index{Miscellaneous Functions@{Miscellaneous Functions}!parseBase64StringToString@{parseBase64StringToString}} \index{parseBase64StringToString@{parseBase64StringToString}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{parseBase64StringToString()}{parseBase64StringToString()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::parse\+Base64\+String\+To\+String (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{str, }\item[{\+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{encoding }\end{DoxyParamCaption})} Parses a base64 encoded string and returns a string of the decoded data. Implementation based on \href{http://www.ietf.org/rfc/rfc1421.txt}{\texttt{ RFC-\/1421}} and \href{http://www.ietf.org/rfc/rfc2045.txt}{\texttt{ RFC-\/2045}} \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_RET_VALUE_ONLY}{RET\+\_\+\+VALUE\+\_\+\+ONLY}}, \mbox{\hyperlink{code_flags_DEPRECATED}{DEPRECATED}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em str} & the base64-\/encoded input data to decode \\ \hline {\em encoding} & the character encoding tag for the string return value; if not present, the \mbox{\hyperlink{character_encoding_default_encoding}{default character encoding}} is assumed.\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} a string of the decoded data tagged with the given encoding \end{DoxyReturn} \begin{DoxyExceptions}{Exceptions} {\em BASE64-\/\+PARSE-\/\+ERROR} & A syntax error occurred parsing the base64 string (invalid character, etc)\\ \hline \end{DoxyExceptions} \begin{DoxySince}{Since} the encoding parameter was added in Qore 0.\+8.\+4 \end{DoxySince} \begin{DoxySeeAlso}{See also} \begin{DoxyItemize} \item \mbox{\hyperlink{group__misc__functions_gaedf4a2c140fa284c9e09a68b743763b3}{parse\+\_\+hex\+\_\+string()}} \item \mbox{\hyperlink{group__misc__functions_ga34c9bccc1d1e61d6a8a8988ceb4a8a6c}{parse\+\_\+base64\+\_\+string()}} \end{DoxyItemize} \end{DoxySeeAlso} \begin{DoxyRefDesc}{Deprecated} \item[\mbox{\hyperlink{deprecated__deprecated000031}{Deprecated}}]use \mbox{\hyperlink{group__misc__functions_ga0160c0c4cbe7180d70048577e4e40bcc}{parse\+\_\+base64\+\_\+string\+\_\+to\+\_\+string()}}; camel-\/case function names were deprecated in Qore 0.\+8.\+12 \end{DoxyRefDesc} \mbox{\Hypertarget{group__misc__functions_ga64ee3ae01383697ae0174fd0cf6cbc5e}\label{group__misc__functions_ga64ee3ae01383697ae0174fd0cf6cbc5e}} \index{Miscellaneous Functions@{Miscellaneous Functions}!parseHexString@{parseHexString}} \index{parseHexString@{parseHexString}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{parseHexString()}{parseHexString()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} {\footnotesize\ttfamily nothing Qore\+::parse\+Hex\+String (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_RUNTIME_NOOP}{RUNTIME\+\_\+\+NOOP}}, \mbox{\hyperlink{code_flags_DEPRECATED}{DEPRECATED}} \end{DoxyParagraph} \mbox{\Hypertarget{group__misc__functions_ga74fed7603d2176dd5d433d3fae02ad9f}\label{group__misc__functions_ga74fed7603d2176dd5d433d3fae02ad9f}} \index{Miscellaneous Functions@{Miscellaneous Functions}!parseHexString@{parseHexString}} \index{parseHexString@{parseHexString}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{parseHexString()}{parseHexString()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gaf11c7f5c43ced1e9b95bd2270ee87ed9}{binary}} Qore\+::parse\+Hex\+String (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{hexstr }\end{DoxyParamCaption})} Parses a hex-\/encoded string and returns the binary object. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_RET_VALUE_ONLY}{RET\+\_\+\+VALUE\+\_\+\+ONLY}}, \mbox{\hyperlink{code_flags_DEPRECATED}{DEPRECATED}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em hexstr} & a string of an even-\/number of only hexadecimal digits\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} a binary object of the decoded data \end{DoxyReturn} \begin{DoxyExceptions}{Exceptions} {\em PARSE-\/\+HEX-\/\+ERROR} & A syntax error occurred parsing the hex string (odd number of digits, invalid hex character, etc)\\ \hline \end{DoxyExceptions} \begin{DoxySeeAlso}{See also} \begin{DoxyItemize} \item \mbox{\hyperlink{group__misc__functions_ga34c9bccc1d1e61d6a8a8988ceb4a8a6c}{parse\+\_\+base64\+\_\+string()}} \item \mbox{\hyperlink{group__misc__functions_gae7be18717b0ed9010c48166a437c35b4}{make\+\_\+hex\+\_\+string()}} \end{DoxyItemize} \end{DoxySeeAlso} \begin{DoxyRefDesc}{Deprecated} \item[\mbox{\hyperlink{deprecated__deprecated000032}{Deprecated}}]use \mbox{\hyperlink{group__misc__functions_gaedf4a2c140fa284c9e09a68b743763b3}{parse\+\_\+hex\+\_\+string()}}; camel-\/case function names were deprecated in Qore 0.\+8.\+12 \end{DoxyRefDesc} \mbox{\Hypertarget{group__misc__functions_gad2514f74637e1955648b867103aea595}\label{group__misc__functions_gad2514f74637e1955648b867103aea595}} \index{Miscellaneous Functions@{Miscellaneous Functions}!parseURL@{parseURL}} \index{parseURL@{parseURL}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{parseURL()}{parseURL()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} {\footnotesize\ttfamily nothing Qore\+::parse\+URL (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_RUNTIME_NOOP}{RUNTIME\+\_\+\+NOOP}} \end{DoxyParagraph} \mbox{\Hypertarget{group__misc__functions_gae1961be84af7e6bc5553049bf978f922}\label{group__misc__functions_gae1961be84af7e6bc5553049bf978f922}} \index{Miscellaneous Functions@{Miscellaneous Functions}!parseURL@{parseURL}} \index{parseURL@{parseURL}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{parseURL()}{parseURL()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} {\footnotesize\ttfamily \+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_ga0231dbb472dd230310af7c7c34f56e92}{hash}}$<$\mbox{\hyperlink{struct_qore_1_1_url_info}{Url\+Info}}$>$ Qore\+::parse\+URL (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{url, }\item[{bool}]{keep\+\_\+brackets = {\ttfamily \mbox{\hyperlink{group__boolean__constants_ga9da2b9a8003cd3788e48305f8a00540f}{False}}} }\end{DoxyParamCaption})} Parses a URL string and returns a hash of the components; if the URL cannot be parsed then \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} is returned. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em url} & the URL to parse (ex\+: {\ttfamily \char`\"{}https\+://user\+:pass@host\+:8080/path\char`\"{}}); either a hostname or path is required at a minimum or the function will return \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} \\ \hline {\em keep\+\_\+brackets} & if this argument is true then if the hostname or address is enclosed in square brackets, then the brackets will be included in the {\ttfamily \char`\"{}host\char`\"{}} key output as well; square brackets are used by some Qore methods to denote IPv6 addresses; for example see \mbox{\hyperlink{class_qore_1_1_socket_a7e0dc386a95c3c6a0e1cc12269d4374b}{Socket\+::connect()}}\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} a hash of the components of the URL with the following keys (if data in the URL is present; note that at least either the {\ttfamily \char`\"{}host\char`\"{}} or the {\ttfamily \char`\"{}path\char`\"{}} keys will always be returned if a hash is returned)\+: \begin{DoxyItemize} \item {\ttfamily protocol\+:} the scheme in the URL (ex\+: {\ttfamily \char`\"{}http\char`\"{}}) \item {\ttfamily path\+:} any path given in the URL; the path will be prefixed by {\ttfamily \char`\"{}/\char`\"{}} if a hostname is found in the URL argument string, otherwise it will not if it was not given as such in the argument string -\/ not subjected to percent decoding (see note below) \item {\ttfamily username\+:} any username given in the URL -\/ not subjected to percent decoding (see note below) \item {\ttfamily password\+:} any password given in the URL -\/ not subjected to percent decoding (see note below) \item {\ttfamily host\+:} any hostname given in the URL; note that this key will be given if no other information can be found in the URL argument and the URL argument string has no {\ttfamily \char`\"{}/\char`\"{}} characters; depending on the usage context for this function, this may actually be a filename -\/ not subjected to percent decoding (see note below) \item {\ttfamily port\+:} any port number given in the URL \end{DoxyItemize} \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{*hash h = \mbox{\hyperlink{group__misc__functions_gae1961be84af7e6bc5553049bf978f922}{parseURL}}(url\_string);} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyNote}{Note} \begin{DoxyItemize} \item URLs with UNIX sockets are generally supported in \mbox{\hyperlink{namespace_qore}{Qore}} with the following syntax\+: {\ttfamily {\bfseries{scheme\+://socket=}}}{\itshape url\+\_\+encoded\+\_\+path}{\ttfamily {\bfseries{/path}}}, where {\itshape url\+\_\+encoded\+\_\+path} is a path with URL-\/encoding as performed by \mbox{\hyperlink{group__misc__functions_ga639fba8c278c69ac4d4190ca1db19235}{encode\+\_\+url(string, True)}}; for example\+: {\ttfamily \char`\"{}http\+://socket=\%2ftmp\%socket-\/dir\%2fsocket-\/file-\/1/url/path\char`\"{}}; this allows a filesystem path to be used in the host portion of the URL and for the URL to include a URL path as well. \item none of the string fields returned here are subjected to percent decoding; to decode percent encoding, call \mbox{\hyperlink{group__misc__functions_ga51b949c2d20900fdc2e1b8e46988d2b1}{decode\+\_\+url()}} on the strings manually or use the \mbox{\hyperlink{group__misc__functions_gad08ab1d19f1e77fbaa3d1a3d626ee45c}{parse\+\_\+url(string, \+\_\+\+\_\+7\+\_\+ int)}} variant with the \mbox{\hyperlink{group__parse__url__options_ga8c41e16cce13b426c12c9e28f0cb7b29}{QURL\+\_\+\+DECODE}} or \mbox{\hyperlink{group__parse__url__options_gad653e5829af0534c19a3873905cc74d9}{QURL\+\_\+\+DECODE\+\_\+\+PATH}} options \end{DoxyItemize} \end{DoxyNote} \begin{DoxySeeAlso}{See also} \mbox{\hyperlink{group__misc__functions_ga4e22308b56f16f8bd090e69ed3bad451}{parse\+\_\+url()}} for a version of this function that throws exceptions if the URL cannot be parsed \end{DoxySeeAlso} \mbox{\Hypertarget{group__misc__functions_ga84fcab69e514fd31cefe8de51bbe8acd}\label{group__misc__functions_ga84fcab69e514fd31cefe8de51bbe8acd}} \index{Miscellaneous Functions@{Miscellaneous Functions}!reload\_module@{reload\_module}} \index{reload\_module@{reload\_module}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{reload\_module()}{reload\_module()}} {\footnotesize\ttfamily nothing Qore\+::reload\+\_\+module (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{name }\end{DoxyParamCaption})} Reloads an already-\/loaded Qore module subject to code injection at run-\/time into Qore; the module\textquotesingle{}s code is not imported into the current \mbox{\hyperlink{class_qore_1_1_program}{Program}} object. \begin{DoxyParagraph}{Restrictions\+:} \mbox{\hyperlink{group__parse__options_gaccf9af08f7acb25e66b777dcb4c4563b}{Qore\+::\+PO\+\_\+\+NO\+\_\+\+MODULES}}, MUST HAVE\+: \mbox{\hyperlink{group__parse__options_ga1c78ca9bda4b8f5b2ad669c48fe0368d}{Qore\+::\+PO\+\_\+\+ALLOW\+\_\+\+INJECTION}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em name} & a feature name for an already-\/loaded module\\ \hline \end{DoxyParams} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{\mbox{\hyperlink{group__misc__functions_ga84fcab69e514fd31cefe8de51bbe8acd}{reload\_module}}(\textcolor{stringliteral}{"{}FixedLengthUtil"{}});} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyExceptions}{Exceptions} {\em LOAD-\/\+MODULE-\/\+ERROR} & module cannot be loaded\+: API incompatibility, etc\\ \hline \end{DoxyExceptions} \begin{DoxyNote}{Note} \begin{DoxyItemize} \item unlike \mbox{\hyperlink{group__misc__functions_gaf0922a51e6c5471b02a947cb0cb008ba}{load\+\_\+module()}}, this function does not cause the given module\textquotesingle{}s code to be loaded in the current \mbox{\hyperlink{class_qore_1_1_program}{Program}} object \item in case the given feature has not been loaded or has already been loaded and was not subject to code injection, this call is silently ignored \end{DoxyItemize} \end{DoxyNote} \begin{DoxySeeAlso}{See also} \begin{DoxyItemize} \item \mbox{\hyperlink{group__misc__functions_gaf0922a51e6c5471b02a947cb0cb008ba}{load\+\_\+module()}} \end{DoxyItemize} \end{DoxySeeAlso} \begin{DoxySince}{Since} Qore 0.\+8.\+12 \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_gaea05595c0ea4cf4affef51c323c7eed1}\label{group__misc__functions_gaea05595c0ea4cf4affef51c323c7eed1}} \index{Miscellaneous Functions@{Miscellaneous Functions}!set\_global\_var\_value@{set\_global\_var\_value}} \index{set\_global\_var\_value@{set\_global\_var\_value}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{set\_global\_var\_value()}{set\_global\_var\_value()}} {\footnotesize\ttfamily nothing Qore\+::set\+\_\+global\+\_\+var\+\_\+value (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{name, }\item[{auto}]{value }\end{DoxyParamCaption})} set the value of a global variable \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{\mbox{\hyperlink{group__misc__functions_gaea05595c0ea4cf4affef51c323c7eed1}{set\_global\_var\_value}}(\textcolor{stringliteral}{"{}a"{}}, 1);} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em name} & the name of the variable \\ \hline {\em value} & the value to assign\\ \hline \end{DoxyParams} \begin{DoxyExceptions}{Exceptions} {\em UNKNOWN-\/\+VARIABLE} & the variable is not a global variable\\ \hline \end{DoxyExceptions} \begin{DoxyNote}{Note} other exceptions could be thrown if the value cannot be assigned to the given variable \end{DoxyNote} \begin{DoxySeeAlso}{See also} \mbox{\hyperlink{class_qore_1_1_program_a8be97bfcd125d83a9415c843694734ac}{Qore\+::\+Program\+::set\+Global\+Var\+Value()}} \end{DoxySeeAlso} \begin{DoxySince}{Since} Qore 0.\+8.\+13 \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_ga20e0c1f20a6afc4b02dbd9862996d57a}\label{group__misc__functions_ga20e0c1f20a6afc4b02dbd9862996d57a}} \index{Miscellaneous Functions@{Miscellaneous Functions}!set\_local\_var\_value@{set\_local\_var\_value}} \index{set\_local\_var\_value@{set\_local\_var\_value}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{set\_local\_var\_value()}{set\_local\_var\_value()}} {\footnotesize\ttfamily nothing Qore\+::set\+\_\+local\+\_\+var\+\_\+value (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}}}]{frame, }\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{var, }\item[{auto}]{value }\end{DoxyParamCaption})} sets the value of the given local variable; if the variable cannot be found an exception is raised \begin{DoxyParagraph}{Restrictions\+:} MUST HAVE\+: \mbox{\hyperlink{group__parse__options_gad0d38cd46f08bf4210d4010204269cc9}{Qore\+::\+PO\+\_\+\+ALLOW\+\_\+\+DEBUGGER}} \end{DoxyParagraph} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{\mbox{\hyperlink{group__misc__functions_ga20e0c1f20a6afc4b02dbd9862996d57a}{set\_local\_var\_value}}(0, \textcolor{stringliteral}{"{}var"{}}, 1);} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em frame} & the stack frame where 0 is the current or highest stack frame \\ \hline {\em var} & the name of the local variable \\ \hline {\em value} & the value to assign\\ \hline \end{DoxyParams} \begin{DoxyExceptions}{Exceptions} {\em UNKNOWN-\/\+VARIABLE} & the given local variable is not present in the current stack frame\\ \hline \end{DoxyExceptions} \begin{DoxyNote}{Note} \begin{DoxyItemize} \item other exceptions could be raised when making the assignment such as incompatible type exceptions \item pure local variables (i.\+e. not closure bound and not subject to the reference operator) are not stored with type information at runtime; type information is only enforced at parse / compile time, therefore it\textquotesingle{}s possible to set local variables with invalid values that contradict their declarations with this function \end{DoxyItemize} \end{DoxyNote} \begin{DoxySince}{Since} Qore 0.\+8.\+13 \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_ga9034376bb44beb761d76156600b537f8}\label{group__misc__functions_ga9034376bb44beb761d76156600b537f8}} \index{Miscellaneous Functions@{Miscellaneous Functions}!set\_module\_option@{set\_module\_option}} \index{set\_module\_option@{set\_module\_option}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{set\_module\_option()}{set\_module\_option()}} {\footnotesize\ttfamily nothing Qore\+::set\+\_\+module\+\_\+option (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{module, }\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{option, }\item[{auto}]{value }\end{DoxyParamCaption})} set the given module option \begin{DoxyParagraph}{Restrictions\+:} \mbox{\hyperlink{group__parse__options_ga10d8e3f76c427b0f974529de572dd0ec}{Qore\+::\+PO\+\_\+\+NO\+\_\+\+PROCESS\+\_\+\+CONTROL}} \end{DoxyParagraph} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{\mbox{\hyperlink{group__misc__functions_ga9034376bb44beb761d76156600b537f8}{set\_module\_option}}(mod, opt, val);} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em module} & the name of the module \\ \hline {\em option} & the name of the option \\ \hline {\em value} & the value to assign; setting to \mbox{\hyperlink{basic_data_types_nothing}{NOTHING}} removes the module option\\ \hline \end{DoxyParams} \begin{DoxySeeAlso}{See also} \mbox{\hyperlink{group__misc__functions_ga26bb5a87af0e8be0e661a590fb722c83}{get\+\_\+module\+\_\+option()}} \end{DoxySeeAlso} \begin{DoxySince}{Since} Qore 0.\+9 \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_ga51444e624e7ba2b2ecfb45dd49e6db42}\label{group__misc__functions_ga51444e624e7ba2b2ecfb45dd49e6db42}} \index{Miscellaneous Functions@{Miscellaneous Functions}!set\_return\_value@{set\_return\_value}} \index{set\_return\_value@{set\_return\_value}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{set\_return\_value()}{set\_return\_value()}} {\footnotesize\ttfamily Qore\+::set\+\_\+return\+\_\+value (\begin{DoxyParamCaption}\item[{auto}]{val }\end{DoxyParamCaption})} sets the return value for a \mbox{\hyperlink{class_qore_1_1_program}{Program}} object when running with \mbox{\hyperlink{parse_directives_exec-class}{\%exec-\/class}} \begin{DoxyParagraph}{Restrictions\+:} \mbox{\hyperlink{group__parse__options_ga10d8e3f76c427b0f974529de572dd0ec}{Qore\+::\+PO\+\_\+\+NO\+\_\+\+PROCESS\+\_\+\+CONTROL}} \end{DoxyParagraph} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{\mbox{\hyperlink{group__misc__functions_ga51444e624e7ba2b2ecfb45dd49e6db42}{set\_return\_value}}(1);} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em val} & the return value for the \mbox{\hyperlink{class_qore_1_1_program}{Program}}\\ \hline \end{DoxyParams} \begin{DoxyExceptions}{Exceptions} {\em SETRETURNVALUE-\/\+ERROR} & this exception is thrown if the \mbox{\hyperlink{class_qore_1_1_program}{Program}} is not currently running in \mbox{\hyperlink{parse_directives_exec-class}{\%exec-\/class}} mode\\ \hline \end{DoxyExceptions} \begin{DoxySince}{Since} Qore 0.\+8.\+12 \end{DoxySince} \mbox{\Hypertarget{group__misc__functions_ga7434c1e84c31c32b816312e7a846e876}\label{group__misc__functions_ga7434c1e84c31c32b816312e7a846e876}} \index{Miscellaneous Functions@{Miscellaneous Functions}!splice@{splice}} \index{splice@{splice}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{splice()}{splice()}\hspace{0.1cm}{\footnotesize\ttfamily [1/7]}} {\footnotesize\ttfamily nothing Qore\+::splice (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_RUNTIME_NOOP}{RUNTIME\+\_\+\+NOOP}} \end{DoxyParagraph} \mbox{\Hypertarget{group__misc__functions_ga8ef232e117e3b0848e59c97571817d59}\label{group__misc__functions_ga8ef232e117e3b0848e59c97571817d59}} \index{Miscellaneous Functions@{Miscellaneous Functions}!splice@{splice}} \index{splice@{splice}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{splice()}{splice()}\hspace{0.1cm}{\footnotesize\ttfamily [2/7]}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_ga4b52a1cbee7a3aed46c32cb0a938629c}{list}}$<$auto$>$ Qore\+::splice (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_ga4b52a1cbee7a3aed46c32cb0a938629c}{list}}$<$ auto $>$}]{l, }\item[{softint}]{start }\end{DoxyParamCaption})} Returns a list based on the argument list but with elements removed from the given index to the end of the list. Exceptions can only be thrown here if objects are removed from the list and this causes them to go out of scope and an exception is thrown in one of the destructors \begin{DoxyParams}{Parameters} {\em l} & the list to process \\ \hline {\em start} & the starting element (where the first element is 0) to start removing elements; if this value is negative, it gives the offset from the end of the list\\ \hline \end{DoxyParams} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{list l = \mbox{\hyperlink{group__misc__functions_ga3b0fa637025e8fbacdf4e43c33e37dc8}{splice}}(l2, 5);} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxySeeAlso}{See also} the \mbox{\hyperlink{operators_splice}{splice operator}} \end{DoxySeeAlso} \mbox{\Hypertarget{group__misc__functions_gaf89a7fd2369fe278be96948e51b1a807}\label{group__misc__functions_gaf89a7fd2369fe278be96948e51b1a807}} \index{Miscellaneous Functions@{Miscellaneous Functions}!splice@{splice}} \index{splice@{splice}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{splice()}{splice()}\hspace{0.1cm}{\footnotesize\ttfamily [3/7]}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_ga4b52a1cbee7a3aed46c32cb0a938629c}{list}}$<$auto$>$ Qore\+::splice (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_ga4b52a1cbee7a3aed46c32cb0a938629c}{list}}$<$ auto $>$}]{l, }\item[{softint}]{start, }\item[{softint}]{len }\end{DoxyParamCaption})} Returns a list based on the argument list but optionally with elements removed and/or added from a certain index. Exceptions can only be thrown here if objects are removed from the list and this causes them to go out of scope and an exception is thrown in one of the destructors \begin{DoxyParams}{Parameters} {\em l} & the list to process \\ \hline {\em start} & the starting element (where the first element is 0) to start removing (and/or adding) elements; if this value is negative, it gives the offset from the end of the list \\ \hline {\em len} & the number of list elements to remove; if this argument is 0 then no elements are removed; if this value is negative, then it gives an offset from the end of the list (ie -\/2 means remove all elements up to but not including the two last elements)\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the processed list with elements removed and/or added according to the arguments \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{list l = \mbox{\hyperlink{group__misc__functions_ga3b0fa637025e8fbacdf4e43c33e37dc8}{splice}}(l2, 5, 7);} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxySeeAlso}{See also} the \mbox{\hyperlink{operators_splice}{splice operator}} \end{DoxySeeAlso} \mbox{\Hypertarget{group__misc__functions_ga31f7af53c8c0c95199e6be8d9942440f}\label{group__misc__functions_ga31f7af53c8c0c95199e6be8d9942440f}} \index{Miscellaneous Functions@{Miscellaneous Functions}!splice@{splice}} \index{splice@{splice}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{splice()}{splice()}\hspace{0.1cm}{\footnotesize\ttfamily [4/7]}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_ga4b52a1cbee7a3aed46c32cb0a938629c}{list}}$<$auto$>$ Qore\+::splice (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_ga4b52a1cbee7a3aed46c32cb0a938629c}{list}}$<$ auto $>$}]{l, }\item[{softint}]{start, }\item[{softint}]{len, }\item[{softlist$<$ auto $>$}]{nlist }\end{DoxyParamCaption})} Returns a list based on the argument list but optionally with elements removed and/or added from a certain index. Exceptions can only be thrown here if objects are removed from the list and this causes them to go out of scope and an exception is thrown in one of the destructors \begin{DoxyParams}{Parameters} {\em l} & the list to process \\ \hline {\em start} & the starting element (where the first element is 0) to start removing (and/or adding) elements; if this value is negative, it gives the offset from the end of the list \\ \hline {\em len} & the number of list elements to remove; if this argument is 0 then no elements are removed; if this value is negative, then it gives an offset from the end of the list (ie -\/2 means remove all elements up to but not including the two last elements) \\ \hline {\em nlist} & the new list for inserting new elements\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the processed list with elements removed and/or added according to the arguments \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{list l = \mbox{\hyperlink{group__misc__functions_ga3b0fa637025e8fbacdf4e43c33e37dc8}{splice}}(l2, 5, 7, \textcolor{stringliteral}{"{}hello"{}});} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxySeeAlso}{See also} the \mbox{\hyperlink{operators_splice}{splice operator}} \end{DoxySeeAlso} \mbox{\Hypertarget{group__misc__functions_ga3b0fa637025e8fbacdf4e43c33e37dc8}\label{group__misc__functions_ga3b0fa637025e8fbacdf4e43c33e37dc8}} \index{Miscellaneous Functions@{Miscellaneous Functions}!splice@{splice}} \index{splice@{splice}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{splice()}{splice()}\hspace{0.1cm}{\footnotesize\ttfamily [5/7]}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::splice (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{str }\end{DoxyParamCaption})} This function always returns an empty string {\ttfamily \char`\"{}\char`\"{}}. This function variant is included for backwards-\/compatibility \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_NOOP}{NOOP}} \end{DoxyParagraph} \begin{DoxyParams}{Parameters} {\em str} & no action is taken on the argument\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} always returns an empty string {\ttfamily \char`\"{}\char`\"{}} \end{DoxyReturn} \mbox{\Hypertarget{group__misc__functions_ga2d484582db42dcb4752812d3243552bc}\label{group__misc__functions_ga2d484582db42dcb4752812d3243552bc}} \index{Miscellaneous Functions@{Miscellaneous Functions}!splice@{splice}} \index{splice@{splice}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{splice()}{splice()}\hspace{0.1cm}{\footnotesize\ttfamily [6/7]}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::splice (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{str, }\item[{softint}]{start }\end{DoxyParamCaption})} Returns a string based on the argument string but with characters removed from a certain character index. An exception can only be thrown here if an invalid multi-\/byte encoding is found \begin{DoxyParams}{Parameters} {\em str} & the string to process \\ \hline {\em start} & the character index (where the first character is 0) to start removing characters; if this value is negative, it gives the offset from the end of the string\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the processed string \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{string str = \mbox{\hyperlink{group__misc__functions_ga3b0fa637025e8fbacdf4e43c33e37dc8}{splice}}(str2, 5);} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxySeeAlso}{See also} the \mbox{\hyperlink{operators_splice}{splice operator}} \end{DoxySeeAlso} \mbox{\Hypertarget{group__misc__functions_gaaf2f11a128064b10de5cd2ce1fec72d3}\label{group__misc__functions_gaaf2f11a128064b10de5cd2ce1fec72d3}} \index{Miscellaneous Functions@{Miscellaneous Functions}!splice@{splice}} \index{splice@{splice}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{splice()}{splice()}\hspace{0.1cm}{\footnotesize\ttfamily [7/7]}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}} Qore\+::splice (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{str, }\item[{softint}]{start, }\item[{softint}]{len, }\item[{\+\_\+\+\_\+7\+\_\+ \mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{nstr }\end{DoxyParamCaption})} Returns a string based on the argument string but optionally with characters removed and/or added from a certain character index. An exception can only be thrown here if an invalid multi-\/byte encoding is found \begin{DoxyParams}{Parameters} {\em str} & the string to process \\ \hline {\em start} & the character index (where the first character is 0) to start removing (and/or adding) characters; if this value is negative, it gives the offset from the end of the string \\ \hline {\em len} & the number of characters to remove; if this argument is 0 then no characters are removed; if this value is negative, then it gives an offset from the end of the string (ie -\/2 means remove all characters up to but not including the two last characters) \\ \hline {\em nstr} & the optional string for inserting new characters\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the processed string with characters removed and/or added according to the arguments \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{string str = \mbox{\hyperlink{group__misc__functions_ga3b0fa637025e8fbacdf4e43c33e37dc8}{splice}}(str2, 5, 7, \textcolor{stringliteral}{"{}hello"{}});} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxySeeAlso}{See also} the \mbox{\hyperlink{operators_splice}{splice operator}} \end{DoxySeeAlso} \mbox{\Hypertarget{group__misc__functions_ga25647de5f63580b7d3af4b33c4f35702}\label{group__misc__functions_ga25647de5f63580b7d3af4b33c4f35702}} \index{Miscellaneous Functions@{Miscellaneous Functions}!strtoint@{strtoint}} \index{strtoint@{strtoint}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{strtoint()}{strtoint()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} {\footnotesize\ttfamily nothing Qore\+::strtoint (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} This function variant does nothing at all; it is only included for backwards-\/compatibility with qore prior to version 0.\+8.\+0 for functions that would ignore type errors in arguments. \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_RUNTIME_NOOP}{RUNTIME\+\_\+\+NOOP}} \end{DoxyParagraph} \mbox{\Hypertarget{group__misc__functions_ga868cb227993d254a65afb9d21ccba9fe}\label{group__misc__functions_ga868cb227993d254a65afb9d21ccba9fe}} \index{Miscellaneous Functions@{Miscellaneous Functions}!strtoint@{strtoint}} \index{strtoint@{strtoint}!Miscellaneous Functions@{Miscellaneous Functions}} \doxysubsubsection{\texorpdfstring{strtoint()}{strtoint()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} {\footnotesize\ttfamily \mbox{\hyperlink{group__type__conversion__functions_ga2de8717e92c5f97ccc6511f6062d6502}{int}} Qore\+::strtoint (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__type__conversion__functions_gacf16b4126b795f4b6933ef3425cadae3}{string}}}]{num, }\item[{softint}]{base = {\ttfamily 10} }\end{DoxyParamCaption})} parses a string representing a number in a configurable base and returns the integer \begin{DoxyParams}{Parameters} {\em num} & a string representing a number \\ \hline {\em base} & the base of the number\\ \hline \end{DoxyParams} \begin{DoxyReturn}{Returns} the integer represented by the string and the base \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{int i = \mbox{\hyperlink{group__misc__functions_ga868cb227993d254a65afb9d21ccba9fe}{strtoint}}(\textcolor{stringliteral}{"{}41"{}}, 8);} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyExceptions}{Exceptions} {\em STRTOINT-\/\+ERROR} & cannot parse string; unsupported base, etc \\ \hline \end{DoxyExceptions}