\doxysection{Miscellaneous Functions }
\hypertarget{group__miscellaneous}{}\label{group__miscellaneous}\index{Miscellaneous Functions@{Miscellaneous Functions}}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item 
DW\+\_\+\+API const char \texorpdfstring{$\ast$}{*} \doxymbox{\hyperlink{group__miscellaneous_ga715bceecb7a910ebab185972fe9d2dc0}{dwarf\+\_\+package\+\_\+version}} (void)
\begin{DoxyCompactList}\small\item\em Return the version string in the library. \end{DoxyCompactList}\item 
DW\+\_\+\+API int \doxymbox{\hyperlink{group__miscellaneous_gad3a0d2ec4f074032ee6ebd22291bb01d}{dwarf\+\_\+set\+\_\+stringcheck}} (int dw\+\_\+stringcheck)
\begin{DoxyCompactList}\small\item\em Turn off libdwarf checks of strings. \end{DoxyCompactList}\item 
DW\+\_\+\+API int \doxymbox{\hyperlink{group__miscellaneous_ga7639d1bd4b6816f32ad511b6191de12a}{dwarf\+\_\+set\+\_\+reloc\+\_\+application}} (int dw\+\_\+apply)
\begin{DoxyCompactList}\small\item\em Set libdwarf response to \texorpdfstring{$\ast$}{*}.rela relocations. \end{DoxyCompactList}\item 
DW\+\_\+\+API void \doxymbox{\hyperlink{group__miscellaneous_ga46dffbcb2b6bb4bdf971057d5d79e9fa}{dwarf\+\_\+record\+\_\+cmdline\+\_\+options}} (Dwarf\+\_\+\+Cmdline\+\_\+\+Options dw\+\_\+dd\+\_\+options)
\begin{DoxyCompactList}\small\item\em Tell libdwarf to add verbosity to Line Header errors By default the flag in the struct argument is zero. dwarfdump uses this when -\/v used on dwarfdump. \end{DoxyCompactList}\item 
DW\+\_\+\+API int \doxymbox{\hyperlink{group__miscellaneous_gaaeeaaed1a0b21858990691ae5441fb32}{dwarf\+\_\+set\+\_\+de\+\_\+alloc\+\_\+flag}} (int dw\+\_\+v)
\begin{DoxyCompactList}\small\item\em Eliminate libdwarf tracking of allocations Independent of any \doxylink{group__allstructs_gac2ba1e1c1b70a3191506b414195ca807}{Dwarf\+\_\+\+Debug} and applicable to all whenever the setting is changed. Defaults to non-\/zero. \end{DoxyCompactList}\item 
DW\+\_\+\+API int \doxymbox{\hyperlink{group__miscellaneous_gabc31b8456210a8f8fd3770365212c744}{dwarf\+\_\+library\+\_\+allow\+\_\+dup\+\_\+attr}} (int dw\+\_\+v)
\begin{DoxyCompactList}\small\item\em Eliminate libdwarf checking attribute duplication. \end{DoxyCompactList}\item 
DW\+\_\+\+API \doxymbox{\hyperlink{group__basicdatatypes_ga52e439e652a1a30277679f64f83cc0fe}{Dwarf\+\_\+\+Small}} \doxymbox{\hyperlink{group__miscellaneous_ga505e612be969da07f1f14fbc7b68c1ee}{dwarf\+\_\+set\+\_\+default\+\_\+address\+\_\+size}} (\doxymbox{\hyperlink{group__allstructs_gac2ba1e1c1b70a3191506b414195ca807}{Dwarf\+\_\+\+Debug}} dw\+\_\+dbg, \doxymbox{\hyperlink{group__basicdatatypes_ga52e439e652a1a30277679f64f83cc0fe}{Dwarf\+\_\+\+Small}} dw\+\_\+value)
\begin{DoxyCompactList}\small\item\em Set the address size on a \doxylink{group__allstructs_gac2ba1e1c1b70a3191506b414195ca807}{Dwarf\+\_\+\+Debug}. \end{DoxyCompactList}\item 
DW\+\_\+\+API int \doxymbox{\hyperlink{group__miscellaneous_ga51dd900af8bbc3dcec87abf0887b6e68}{dwarf\+\_\+get\+\_\+universalbinary\+\_\+count}} (\doxymbox{\hyperlink{group__allstructs_gac2ba1e1c1b70a3191506b414195ca807}{Dwarf\+\_\+\+Debug}} dw\+\_\+dbg, \doxymbox{\hyperlink{group__basicdatatypes_ga5de64bb9627534a24dcbccc327916265}{Dwarf\+\_\+\+Unsigned}} \texorpdfstring{$\ast$}{*}dw\+\_\+current\+\_\+index, \doxymbox{\hyperlink{group__basicdatatypes_ga5de64bb9627534a24dcbccc327916265}{Dwarf\+\_\+\+Unsigned}} \texorpdfstring{$\ast$}{*}dw\+\_\+available\+\_\+count)
\begin{DoxyCompactList}\small\item\em Retrieve universal binary index. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Variables}
\begin{DoxyCompactItemize}
\item 
DW\+\_\+\+API void(\texorpdfstring{$\ast$}{*})(void \texorpdfstring{$\ast$}{*}, const void \texorpdfstring{$\ast$}{*}, unsigned long) \doxymbox{\hyperlink{group__miscellaneous_ga80cba43615c468754313f63a96dfadca}{dwarf\+\_\+get\+\_\+endian\+\_\+copy\+\_\+function}} (\doxymbox{\hyperlink{group__allstructs_gac2ba1e1c1b70a3191506b414195ca807}{Dwarf\+\_\+\+Debug}} dw\+\_\+dbg)
\begin{DoxyCompactList}\small\item\em Get a pointer to the applicable swap/\+noswap function. \end{DoxyCompactList}\item 
\Hypertarget{group__miscellaneous_ga23d4c3b3a2ca1deb94f98fab6cb5bc24}\label{group__miscellaneous_ga23d4c3b3a2ca1deb94f98fab6cb5bc24} 
DW\+\_\+\+API Dwarf\+\_\+\+Cmdline\+\_\+\+Options {\bfseries dwarf\+\_\+cmdline\+\_\+options}
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}


\label{doc-func-members}
\Hypertarget{group__miscellaneous_doc-func-members}
\doxysubsection{Function Documentation}
\Hypertarget{group__miscellaneous_ga51dd900af8bbc3dcec87abf0887b6e68}\index{Miscellaneous Functions@{Miscellaneous Functions}!dwarf\_get\_universalbinary\_count@{dwarf\_get\_universalbinary\_count}}
\index{dwarf\_get\_universalbinary\_count@{dwarf\_get\_universalbinary\_count}!Miscellaneous Functions@{Miscellaneous Functions}}
\doxysubsubsection{\texorpdfstring{dwarf\_get\_universalbinary\_count()}{dwarf\_get\_universalbinary\_count()}}
{\footnotesize\ttfamily \label{group__miscellaneous_ga51dd900af8bbc3dcec87abf0887b6e68} 
DW\+\_\+\+API int dwarf\+\_\+get\+\_\+universalbinary\+\_\+count (\begin{DoxyParamCaption}\item[{\doxymbox{\hyperlink{group__allstructs_gac2ba1e1c1b70a3191506b414195ca807}{Dwarf\+\_\+\+Debug}}}]{dw\+\_\+dbg}{, }\item[{\doxymbox{\hyperlink{group__basicdatatypes_ga5de64bb9627534a24dcbccc327916265}{Dwarf\+\_\+\+Unsigned}} \texorpdfstring{$\ast$}{*}}]{dw\+\_\+current\+\_\+index}{, }\item[{\doxymbox{\hyperlink{group__basicdatatypes_ga5de64bb9627534a24dcbccc327916265}{Dwarf\+\_\+\+Unsigned}} \texorpdfstring{$\ast$}{*}}]{dw\+\_\+available\+\_\+count}{}\end{DoxyParamCaption})}



Retrieve universal binary index. 

For Mach-\/O universal binaries this returns relevant information.

For non-\/universal binaries (Mach-\/O, Elf, or PE) the values are not meaningful, so the function returns DW\+\_\+\+DLV\+\_\+\+NO\+\_\+\+ENTRY..


\begin{DoxyParams}{Parameters}
{\em dw\+\_\+dbg} & The \doxylink{group__allstructs_gac2ba1e1c1b70a3191506b414195ca807}{Dwarf\+\_\+\+Debug} of interest. \\
\hline
{\em dw\+\_\+current\+\_\+index} & If dw\+\_\+current\+\_\+index is passed in non-\/null the function returns the universal-\/binary index of the current object (which came from a universal binary). \\
\hline
{\em dw\+\_\+available\+\_\+count} & If dw\+\_\+current\+\_\+index is passed in non-\/null the function returns the count of binaries in the universal binary. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Returns DW\+\_\+\+DLV\+\_\+\+NO\+\_\+\+ENTRY if the object file is not from a Mach-\/O universal binary. Returns DW\+\_\+\+DLV\+\_\+\+NO\+\_\+\+ENTRY if dw\+\_\+dbg is passed in NULL. Never returns DW\+\_\+\+DLV\+\_\+\+ERROR. 
\end{DoxyReturn}
\Hypertarget{group__miscellaneous_gabc31b8456210a8f8fd3770365212c744}\index{Miscellaneous Functions@{Miscellaneous Functions}!dwarf\_library\_allow\_dup\_attr@{dwarf\_library\_allow\_dup\_attr}}
\index{dwarf\_library\_allow\_dup\_attr@{dwarf\_library\_allow\_dup\_attr}!Miscellaneous Functions@{Miscellaneous Functions}}
\doxysubsubsection{\texorpdfstring{dwarf\_library\_allow\_dup\_attr()}{dwarf\_library\_allow\_dup\_attr()}}
{\footnotesize\ttfamily \label{group__miscellaneous_gabc31b8456210a8f8fd3770365212c744} 
DW\+\_\+\+API int dwarf\+\_\+library\+\_\+allow\+\_\+dup\+\_\+attr (\begin{DoxyParamCaption}\item[{int}]{dw\+\_\+v}{}\end{DoxyParamCaption})}



Eliminate libdwarf checking attribute duplication. 

Independent of any \doxylink{group__allstructs_gac2ba1e1c1b70a3191506b414195ca807}{Dwarf\+\_\+\+Debug}, this is sets a global flag in libdwarf and is applicable to all whenever the setting is changed. Defaults to zero so by default libdwarf does check every set of abbreviations for duplicate attributes.

DWARF5 Sec 2.\+2 Attribute Types Each attribute value is characterized by an attribute name. No more than one attribute with a given name may appear in any debugging information entry. Essentially the same wording is in Sec 2.\+2 of DWARF2, DWARF3 and DWARF4.

Do not call this with non-\/zero dw\+\_\+v unless you really want the library to avoid this basic DWARF-\/correctness check.

\begin{DoxySince}{Since}
\{0.\+12.\+0\}
\end{DoxySince}

\begin{DoxyParams}{Parameters}
{\em dw\+\_\+v} & If non-\/zero passed in libdwarf will avoid the checks and will not return errors for an abbreviation list with duplicate attributes. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Returns the previous version of the flag. 
\end{DoxyReturn}
\Hypertarget{group__miscellaneous_ga715bceecb7a910ebab185972fe9d2dc0}\index{Miscellaneous Functions@{Miscellaneous Functions}!dwarf\_package\_version@{dwarf\_package\_version}}
\index{dwarf\_package\_version@{dwarf\_package\_version}!Miscellaneous Functions@{Miscellaneous Functions}}
\doxysubsubsection{\texorpdfstring{dwarf\_package\_version()}{dwarf\_package\_version()}}
{\footnotesize\ttfamily \label{group__miscellaneous_ga715bceecb7a910ebab185972fe9d2dc0} 
DW\+\_\+\+API const char \texorpdfstring{$\ast$}{*} dwarf\+\_\+package\+\_\+version (\begin{DoxyParamCaption}\item[{void}]{}{}\end{DoxyParamCaption})}



Return the version string in the library. 

An example:\+ "{}0.\+3.\+0"{} which is a Semantic Version identifier. Before September 2021 the version string was a date, for example "{}20210528"{}, which is in ISO date format. See DW\+\_\+\+LIBDWARF\+\_\+\+VERSION DW\+\_\+\+LIBDWARF\+\_\+\+VERSION\+\_\+\+MAJOR DW\+\_\+\+LIBDWARF\+\_\+\+VERSION\+\_\+\+MINOR DW\+\_\+\+LIBDWARF\+\_\+\+VERSION\+\_\+\+MICRO \begin{DoxyReturn}{Returns}
The Package Version built into libdwarf.\+so or libdwarf.\+a 
\end{DoxyReturn}
\Hypertarget{group__miscellaneous_ga46dffbcb2b6bb4bdf971057d5d79e9fa}\index{Miscellaneous Functions@{Miscellaneous Functions}!dwarf\_record\_cmdline\_options@{dwarf\_record\_cmdline\_options}}
\index{dwarf\_record\_cmdline\_options@{dwarf\_record\_cmdline\_options}!Miscellaneous Functions@{Miscellaneous Functions}}
\doxysubsubsection{\texorpdfstring{dwarf\_record\_cmdline\_options()}{dwarf\_record\_cmdline\_options()}}
{\footnotesize\ttfamily \label{group__miscellaneous_ga46dffbcb2b6bb4bdf971057d5d79e9fa} 
DW\+\_\+\+API void dwarf\+\_\+record\+\_\+cmdline\+\_\+options (\begin{DoxyParamCaption}\item[{Dwarf\+\_\+\+Cmdline\+\_\+\+Options}]{dw\+\_\+dd\+\_\+options}{}\end{DoxyParamCaption})}



Tell libdwarf to add verbosity to Line Header errors By default the flag in the struct argument is zero. dwarfdump uses this when -\/v used on dwarfdump. 

\begin{DoxySeeAlso}{See also}
\doxylink{group__linetable_gafe667c13df2d38f4aaffef4fad273744}{dwarf\+\_\+register\+\_\+printf\+\_\+callback}
\end{DoxySeeAlso}

\begin{DoxyParams}{Parameters}
{\em dw\+\_\+dd\+\_\+options} & The structure has one flag, and if the flag is nonzero and there is an error in reading a line table header the function passes back detail error messages via dwarf\+\_\+register\+\_\+printf\+\_\+callback. \\
\hline
\end{DoxyParams}
\Hypertarget{group__miscellaneous_gaaeeaaed1a0b21858990691ae5441fb32}\index{Miscellaneous Functions@{Miscellaneous Functions}!dwarf\_set\_de\_alloc\_flag@{dwarf\_set\_de\_alloc\_flag}}
\index{dwarf\_set\_de\_alloc\_flag@{dwarf\_set\_de\_alloc\_flag}!Miscellaneous Functions@{Miscellaneous Functions}}
\doxysubsubsection{\texorpdfstring{dwarf\_set\_de\_alloc\_flag()}{dwarf\_set\_de\_alloc\_flag()}}
{\footnotesize\ttfamily \label{group__miscellaneous_gaaeeaaed1a0b21858990691ae5441fb32} 
DW\+\_\+\+API int dwarf\+\_\+set\+\_\+de\+\_\+alloc\+\_\+flag (\begin{DoxyParamCaption}\item[{int}]{dw\+\_\+v}{}\end{DoxyParamCaption})}



Eliminate libdwarf tracking of allocations Independent of any \doxylink{group__allstructs_gac2ba1e1c1b70a3191506b414195ca807}{Dwarf\+\_\+\+Debug} and applicable to all whenever the setting is changed. Defaults to non-\/zero. 


\begin{DoxyParams}{Parameters}
{\em dw\+\_\+v} & If zero passed in libdwarf will run somewhat faster and library memory allocations will not all be tracked and \doxylink{group__initfunctions_ga14a505c07ee5481401735f280f719454}{dwarf\+\_\+finish()} will be unable to free/\+dealloc some things. User code can do the necessary deallocs (as documented), but the normal guarantee that libdwarf will clean up is revoked. If non-\/zero passed in libdwarf will resume or continue tracking allocations \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Returns the previous version of the flag. 
\end{DoxyReturn}
\Hypertarget{group__miscellaneous_ga505e612be969da07f1f14fbc7b68c1ee}\index{Miscellaneous Functions@{Miscellaneous Functions}!dwarf\_set\_default\_address\_size@{dwarf\_set\_default\_address\_size}}
\index{dwarf\_set\_default\_address\_size@{dwarf\_set\_default\_address\_size}!Miscellaneous Functions@{Miscellaneous Functions}}
\doxysubsubsection{\texorpdfstring{dwarf\_set\_default\_address\_size()}{dwarf\_set\_default\_address\_size()}}
{\footnotesize\ttfamily \label{group__miscellaneous_ga505e612be969da07f1f14fbc7b68c1ee} 
DW\+\_\+\+API \doxymbox{\hyperlink{group__basicdatatypes_ga52e439e652a1a30277679f64f83cc0fe}{Dwarf\+\_\+\+Small}} dwarf\+\_\+set\+\_\+default\+\_\+address\+\_\+size (\begin{DoxyParamCaption}\item[{\doxymbox{\hyperlink{group__allstructs_gac2ba1e1c1b70a3191506b414195ca807}{Dwarf\+\_\+\+Debug}}}]{dw\+\_\+dbg}{, }\item[{\doxymbox{\hyperlink{group__basicdatatypes_ga52e439e652a1a30277679f64f83cc0fe}{Dwarf\+\_\+\+Small}}}]{dw\+\_\+value}{}\end{DoxyParamCaption})}



Set the address size on a \doxylink{group__allstructs_gac2ba1e1c1b70a3191506b414195ca807}{Dwarf\+\_\+\+Debug}. 

DWARF information CUs and other section DWARF headers define a CU-\/specific address size, but this \doxylink{group__allstructs_gac2ba1e1c1b70a3191506b414195ca807}{Dwarf\+\_\+\+Debug} value is used when other address size information does not exist, for example in a DWARF2 CIE or FDE.


\begin{DoxyParams}{Parameters}
{\em dw\+\_\+dbg} & The \doxylink{group__allstructs_gac2ba1e1c1b70a3191506b414195ca807}{Dwarf\+\_\+\+Debug} of interest. \\
\hline
{\em dw\+\_\+value} & Sets the address size for the \doxylink{group__allstructs_gac2ba1e1c1b70a3191506b414195ca807}{Dwarf\+\_\+\+Debug} to a non-\/zero value. The default address size is derived from headers in the object file. Values larger than the size of \doxylink{group__basicdatatypes_ga16ddc0e584ea1a17237ccf1617f31075}{Dwarf\+\_\+\+Addr} are not set. If zero passed the default is not changed. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Returns the last set address size. 
\end{DoxyReturn}
\Hypertarget{group__miscellaneous_ga7639d1bd4b6816f32ad511b6191de12a}\index{Miscellaneous Functions@{Miscellaneous Functions}!dwarf\_set\_reloc\_application@{dwarf\_set\_reloc\_application}}
\index{dwarf\_set\_reloc\_application@{dwarf\_set\_reloc\_application}!Miscellaneous Functions@{Miscellaneous Functions}}
\doxysubsubsection{\texorpdfstring{dwarf\_set\_reloc\_application()}{dwarf\_set\_reloc\_application()}}
{\footnotesize\ttfamily \label{group__miscellaneous_ga7639d1bd4b6816f32ad511b6191de12a} 
DW\+\_\+\+API int dwarf\+\_\+set\+\_\+reloc\+\_\+application (\begin{DoxyParamCaption}\item[{int}]{dw\+\_\+apply}{}\end{DoxyParamCaption})}



Set libdwarf response to \texorpdfstring{$\ast$}{*}.rela relocations. 

dw\+\_\+apply defaults to 1 and means apply all \textquotesingle{}.rela\textquotesingle{} relocations on reading in a dwarf object section of such relocations. Best to just ignore this function It applies to all \doxylink{group__allstructs_gac2ba1e1c1b70a3191506b414195ca807}{Dwarf\+\_\+\+Debug} open and all opened later in this library instance.


\begin{DoxyParams}{Parameters}
{\em dw\+\_\+apply} & Pass in a zero to turn off reading and applying of .rela relocations, which will likely break reading of .o object files but probably will not break reading executables or shared objects. Pass in non zero (it is really just an 8 bit value, so use a small value) to turn off inspecting .rela sections. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Returns the previous value of the apply flag. 
\end{DoxyReturn}
\Hypertarget{group__miscellaneous_gad3a0d2ec4f074032ee6ebd22291bb01d}\index{Miscellaneous Functions@{Miscellaneous Functions}!dwarf\_set\_stringcheck@{dwarf\_set\_stringcheck}}
\index{dwarf\_set\_stringcheck@{dwarf\_set\_stringcheck}!Miscellaneous Functions@{Miscellaneous Functions}}
\doxysubsubsection{\texorpdfstring{dwarf\_set\_stringcheck()}{dwarf\_set\_stringcheck()}}
{\footnotesize\ttfamily \label{group__miscellaneous_gad3a0d2ec4f074032ee6ebd22291bb01d} 
DW\+\_\+\+API int dwarf\+\_\+set\+\_\+stringcheck (\begin{DoxyParamCaption}\item[{int}]{dw\+\_\+stringcheck}{}\end{DoxyParamCaption})}



Turn off libdwarf checks of strings. 

Zero is the default and means do all string length validity checks. It applies to all \doxylink{group__allstructs_gac2ba1e1c1b70a3191506b414195ca807}{Dwarf\+\_\+\+Debug} open and all opened later in this library instance.


\begin{DoxyParams}{Parameters}
{\em dw\+\_\+stringcheck} & Pass in a small non-\/zero value to turn off all libdwarf string validity checks. It speeds up libdwarf, but...is dangerous and voids all promises the library will not segfault. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Returns the previous value of this flag. 
\end{DoxyReturn}


\label{doc-var-members}
\Hypertarget{group__miscellaneous_doc-var-members}
\doxysubsection{Variable Documentation}
\Hypertarget{group__miscellaneous_ga80cba43615c468754313f63a96dfadca}\index{Miscellaneous Functions@{Miscellaneous Functions}!dwarf\_get\_endian\_copy\_function@{dwarf\_get\_endian\_copy\_function}}
\index{dwarf\_get\_endian\_copy\_function@{dwarf\_get\_endian\_copy\_function}!Miscellaneous Functions@{Miscellaneous Functions}}
\doxysubsubsection{\texorpdfstring{dwarf\_get\_endian\_copy\_function}{dwarf\_get\_endian\_copy\_function}}
{\footnotesize\ttfamily \label{group__miscellaneous_ga80cba43615c468754313f63a96dfadca} 
DW\+\_\+\+API void(\texorpdfstring{$\ast$}{*})(void \texorpdfstring{$\ast$}{*}, const void \texorpdfstring{$\ast$}{*}, unsigned long) dwarf\+\_\+get\+\_\+endian\+\_\+copy\+\_\+function(\doxymbox{\hyperlink{group__allstructs_gac2ba1e1c1b70a3191506b414195ca807}{Dwarf\+\_\+\+Debug}} dw\+\_\+dbg) (\begin{DoxyParamCaption}\item[{\doxymbox{\hyperlink{group__allstructs_gac2ba1e1c1b70a3191506b414195ca807}{Dwarf\+\_\+\+Debug}}}]{dw\+\_\+dbg}{}\end{DoxyParamCaption})}



Get a pointer to the applicable swap/\+noswap function. 

the function pointer returned enables libdwarf users to use the same 64bit/\+32bit/\+16bit word copy as libdwarf does internally for the \doxylink{group__allstructs_gac2ba1e1c1b70a3191506b414195ca807}{Dwarf\+\_\+\+Debug} passed in. The function makes it possible for libdwarf to read either endianness.


\begin{DoxyParams}{Parameters}
{\em dw\+\_\+dbg} & Pass in a pointer to the applicable \doxylink{group__allstructs_gac2ba1e1c1b70a3191506b414195ca807}{Dwarf\+\_\+\+Debug}.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
a pointer to a copy function. If the object file referred to and the libdwarf reading that file are the same endianness the function returned will, when called, do a simple memcpy, effectively, while otherwise it would do a byte-\/swapping copy. It seems unlikely this will be useful to most library users. To call the copy function returned the first argument must be a pointer to the target word and the second must be a pointer to the input word. The third argument is the length to be copied and it must be 2,4,or 8. 
\end{DoxyReturn}
