\hypertarget{group__PROBESAPI}{
\section{Main probe API}
\label{group__PROBESAPI}\index{Main probe API@{Main probe API}}
}
Most of the operations that need to be done in a probe, processing input object, manipulating entities, creating output items.
\subsection*{Files}
\begin{DoxyCompactItemize}
\item
file \hyperlink{probe-api_8h}{probe-\/api.h}
\end{DoxyCompactItemize}
\subsection*{Defines}
\begin{DoxyCompactItemize}
\item
\#define \hyperlink{group__PROBESAPI_ga60d3eaa56be311e42ca265e1610ba357}{probe\_\-item\_\-creat}(name, attrs,...)~probe\_\-obj\_\-creat (name, attrs, \_\-\_\-VA\_\-ARGS\_\-\_\-)
\begin{DoxyCompactList}\small\item\em Create a new item consisting of a name, optional attributes argument and an arbitrary number of entities. \item\end{DoxyCompactList}\item
\hypertarget{group__PROBESAPI_gaed502aacce1f11fcbee62e4c3b474995}{
\#define {\bfseries probe\_\-item\_\-getent}(item, name, n)~probe\_\-obj\_\-getent (item, name, n)}
\label{group__PROBESAPI_gaed502aacce1f11fcbee62e4c3b474995}
\item
\hypertarget{group__PROBESAPI_gad69bb1533565f81eb97329ad8999a274}{
\#define {\bfseries PROBE\_\-EINVAL}~1}
\label{group__PROBESAPI_gad69bb1533565f81eb97329ad8999a274}
\item
\hypertarget{group__PROBESAPI_ga665325994bad09304d8200537d93642b}{
\#define {\bfseries PROBE\_\-ENOELM}~2}
\label{group__PROBESAPI_ga665325994bad09304d8200537d93642b}
\item
\hypertarget{group__PROBESAPI_gac40d965d6387fc705aea7e17dd7680ba}{
\#define {\bfseries PROBE\_\-ENOVAL}~3}
\label{group__PROBESAPI_gac40d965d6387fc705aea7e17dd7680ba}
\item
\hypertarget{group__PROBESAPI_ga74bcecc6555100a7238fdc65f0d6148b}{
\#define {\bfseries PROBE\_\-ENOATTR}~4}
\label{group__PROBESAPI_ga74bcecc6555100a7238fdc65f0d6148b}
\item
\hypertarget{group__PROBESAPI_ga9a5597ef21583fc083506d20a214761a}{
\#define {\bfseries PROBE\_\-EINIT}~5}
\label{group__PROBESAPI_ga9a5597ef21583fc083506d20a214761a}
\item
\hypertarget{group__PROBESAPI_gaa21674196b5cb001c28278c9514be185}{
\#define {\bfseries PROBE\_\-ENOMEM}~6}
\label{group__PROBESAPI_gaa21674196b5cb001c28278c9514be185}
\item
\hypertarget{group__PROBESAPI_gaa6a7dd0ff32488e301fc8b9420acf55c}{
\#define {\bfseries PROBE\_\-EOPNOTSUPP}~7}
\label{group__PROBESAPI_gaa6a7dd0ff32488e301fc8b9420acf55c}
\item
\hypertarget{group__PROBESAPI_ga46a7aab37ba4784bd48fd1e5928ce96e}{
\#define {\bfseries PROBE\_\-ERANGE}~8}
\label{group__PROBESAPI_ga46a7aab37ba4784bd48fd1e5928ce96e}
\item
\hypertarget{group__PROBESAPI_gaf657b90fcfba95adaae13b5052304c63}{
\#define {\bfseries PROBE\_\-EDOM}~9}
\label{group__PROBESAPI_gaf657b90fcfba95adaae13b5052304c63}
\item
\hypertarget{group__PROBESAPI_ga4f022024f2cd09d1d61896e5c2c38255}{
\#define {\bfseries PROBE\_\-EFAULT}~10}
\label{group__PROBESAPI_ga4f022024f2cd09d1d61896e5c2c38255}
\item
\hypertarget{group__PROBESAPI_gaf12236c8016b55ab3faf1113b8b2c891}{
\#define {\bfseries PROBE\_\-EACCES}~11}
\label{group__PROBESAPI_gaf12236c8016b55ab3faf1113b8b2c891}
\item
\hypertarget{group__PROBESAPI_ga17111637d17fa23099a5db55a244d708}{
\#define {\bfseries PROBE\_\-ESETEVAL}~12}
\label{group__PROBESAPI_ga17111637d17fa23099a5db55a244d708}
\item
\hypertarget{group__PROBESAPI_ga06b962b819862cec7b8d5db3435d2ca7}{
\#define {\bfseries PROBE\_\-ENOENT}~13}
\label{group__PROBESAPI_ga06b962b819862cec7b8d5db3435d2ca7}
\item
\hypertarget{group__PROBESAPI_ga851f1cb9529e4ac8d3e4ab659492dac6}{
\#define {\bfseries PROBE\_\-EFATAL}~254}
\label{group__PROBESAPI_ga851f1cb9529e4ac8d3e4ab659492dac6}
\item
\hypertarget{group__PROBESAPI_gac7ffdc136441d8e231cdf0907c2dd03f}{
\#define {\bfseries PROBE\_\-EUNKNOWN}~255}
\label{group__PROBESAPI_gac7ffdc136441d8e231cdf0907c2dd03f}
\item
\hypertarget{group__PROBESAPI_gaa34a95304edba1eb22c8579f3f29bbfb}{
\#define {\bfseries OVAL\_\-STATUS\_\-UNKNOWN}~SYSCHAR\_\-STATUS\_\-UNKNOWN}
\label{group__PROBESAPI_gaa34a95304edba1eb22c8579f3f29bbfb}
\item
\hypertarget{group__PROBESAPI_ga3ddadcd64d38a0a0f71b614829b046f9}{
\#define {\bfseries OVAL\_\-STATUS\_\-ERROR}~SYSCHAR\_\-STATUS\_\-ERROR}
\label{group__PROBESAPI_ga3ddadcd64d38a0a0f71b614829b046f9}
\item
\hypertarget{group__PROBESAPI_ga163b455b276bcd2fb813b3026a3381dd}{
\#define {\bfseries OVAL\_\-STATUS\_\-EXISTS}~SYSCHAR\_\-STATUS\_\-EXISTS}
\label{group__PROBESAPI_ga163b455b276bcd2fb813b3026a3381dd}
\item
\hypertarget{group__PROBESAPI_gae1a56a05542e75d07f55dc0042aa65be}{
\#define {\bfseries OVAL\_\-STATUS\_\-DOESNOTEXIST}~SYSCHAR\_\-STATUS\_\-DOES\_\-NOT\_\-EXIST}
\label{group__PROBESAPI_gae1a56a05542e75d07f55dc0042aa65be}
\item
\hypertarget{group__PROBESAPI_gaa33021f49721bd7f275235360945703c}{
\#define {\bfseries OVAL\_\-STATUS\_\-NOTCOLLECTED}~SYSCHAR\_\-STATUS\_\-NOT\_\-COLLECTED}
\label{group__PROBESAPI_gaa33021f49721bd7f275235360945703c}
\item
\hypertarget{group__PROBESAPI_gabf31b82ea668b210dc889e8706674fca}{
\#define {\bfseries PROBECMD\_\-STE\_\-FETCH}~1}
\label{group__PROBESAPI_gabf31b82ea668b210dc889e8706674fca}
\item
\hypertarget{group__PROBESAPI_ga568b36409fa7ad30440d7b9b339db22d}{
\#define {\bfseries PROBECMD\_\-OBJ\_\-EVAL}~2}
\label{group__PROBESAPI_ga568b36409fa7ad30440d7b9b339db22d}
\end{DoxyCompactItemize}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item
\hyperlink{structSEXP}{SEXP\_\-t} $\ast$ \hyperlink{group__PROBESAPI_ga24a0fe6c46c667ee39d0f765630a52df}{probe\_\-item\_\-build} (const char $\ast$fmt,...)
\begin{DoxyCompactList}\small\item\em Build a new item according to the scpecified format. \item\end{DoxyCompactList}\item
\hyperlink{structSEXP}{SEXP\_\-t} $\ast$ \hyperlink{group__PROBESAPI_gaf696f498bb0fedacae306ec8a21caa91}{probe\_\-item\_\-new} (const char $\ast$name, \hyperlink{structSEXP}{SEXP\_\-t} $\ast$attrs)
\begin{DoxyCompactList}\small\item\em Create a new item with just a name and optional attributes argument. \item\end{DoxyCompactList}\item
\hyperlink{structSEXP}{SEXP\_\-t} $\ast$ \hyperlink{group__PROBESAPI_gaaca01da4a1e288ba36f7eec0657f6bbe}{probe\_\-item\_\-attr\_\-add} (\hyperlink{structSEXP}{SEXP\_\-t} $\ast$item, const char $\ast$name, \hyperlink{structSEXP}{SEXP\_\-t} $\ast$val)
\begin{DoxyCompactList}\small\item\em Add a new attribute to an item. \item\end{DoxyCompactList}\item
\hyperlink{structSEXP}{SEXP\_\-t} $\ast$ \hyperlink{group__PROBESAPI_ga2a72992661ed8812d7d17c20a3cdff52}{probe\_\-item\_\-ent\_\-add} (\hyperlink{structSEXP}{SEXP\_\-t} $\ast$item, const char $\ast$name, \hyperlink{structSEXP}{SEXP\_\-t} $\ast$attrs, \hyperlink{structSEXP}{SEXP\_\-t} $\ast$val)
\begin{DoxyCompactList}\small\item\em Add a new entity to an item. \item\end{DoxyCompactList}\item
int \hyperlink{group__PROBESAPI_ga816e3a0f4022b42e80adb37e712217a1}{probe\_\-item\_\-setstatus} (\hyperlink{structSEXP}{SEXP\_\-t} $\ast$obj, \hyperlink{group__OVALSYS_gacf14e82865b7254b573e9a98e7fae422}{oval\_\-syschar\_\-status\_\-t} status)
\begin{DoxyCompactList}\small\item\em Set item's status. \item\end{DoxyCompactList}\item
int \hyperlink{group__PROBESAPI_gad25f90c27a7f5a76abd4348a2777b138}{probe\_\-itement\_\-setstatus} (\hyperlink{structSEXP}{SEXP\_\-t} $\ast$obj, const char $\ast$name, uint32\_\-t n, \hyperlink{group__OVALSYS_gacf14e82865b7254b573e9a98e7fae422}{oval\_\-syschar\_\-status\_\-t} status)
\begin{DoxyCompactList}\small\item\em Set status of an item's entity. \item\end{DoxyCompactList}\item
\hyperlink{structSEXP}{SEXP\_\-t} $\ast$ \hyperlink{group__PROBESAPI_ga57a33271acce2f5013c1a66b0f106a0a}{probe\_\-item\_\-newid} (struct \hyperlink{structid__desc__t}{id\_\-desc\_\-t} $\ast$id\_\-desc)
\begin{DoxyCompactList}\small\item\em Get a new unique id (within a probe) for an item. \item\end{DoxyCompactList}\item
void \hyperlink{group__PROBESAPI_gaebff8a78f7110b657f693e919f2583d1}{probe\_\-item\_\-resetid} (struct \hyperlink{structid__desc__t}{id\_\-desc\_\-t} $\ast$id\_\-desc)
\begin{DoxyCompactList}\small\item\em Reset the item id generator. \item\end{DoxyCompactList}\item
\hyperlink{structSEXP}{SEXP\_\-t} $\ast$ \hyperlink{group__PROBESAPI_gaa108cf08d3ad894f06e7eee7c0100047}{probe\_\-attr\_\-creat} (const char $\ast$name, const \hyperlink{structSEXP}{SEXP\_\-t} $\ast$val,...)
\begin{DoxyCompactList}\small\item\em Create a new list of attributes. \item\end{DoxyCompactList}\item
\hyperlink{structSEXP}{SEXP\_\-t} $\ast$ \hyperlink{group__PROBESAPI_gac6a32ee967031ae45ccb7b29806715ed}{probe\_\-obj\_\-build} (const char $\ast$fmt,...)
\begin{DoxyCompactList}\small\item\em Build a new object according to the scpecified format. \item\end{DoxyCompactList}\item
\hyperlink{structSEXP}{SEXP\_\-t} $\ast$ \hyperlink{group__PROBESAPI_ga280020101f5ef03123a7e2ff6a0b282e}{probe\_\-obj\_\-creat} (const char $\ast$name, \hyperlink{structSEXP}{SEXP\_\-t} $\ast$attrs,...)
\begin{DoxyCompactList}\small\item\em Create a new object consisting of a name, optional attributes argument and an arbitrary number of entities. \item\end{DoxyCompactList}\item
\hyperlink{structSEXP}{SEXP\_\-t} $\ast$ \hyperlink{group__PROBESAPI_ga2539ca96f41a72a89224318c31a19ba9}{probe\_\-obj\_\-new} (const char $\ast$name, \hyperlink{structSEXP}{SEXP\_\-t} $\ast$attrs)
\begin{DoxyCompactList}\small\item\em Create a new object with just a name and optional attributes argument. \item\end{DoxyCompactList}\item
\hyperlink{structSEXP}{SEXP\_\-t} $\ast$ \hyperlink{group__PROBESAPI_gac9d092361f39bc8514fcbb0418f47070}{probe\_\-obj\_\-getent} (const \hyperlink{structSEXP}{SEXP\_\-t} $\ast$obj, const char $\ast$name, uint32\_\-t n)
\begin{DoxyCompactList}\small\item\em Get an entity from an object. \item\end{DoxyCompactList}\item
\hyperlink{structSEXP}{SEXP\_\-t} $\ast$ \hyperlink{group__PROBESAPI_gab73d2c29b3b3657eb4a42c5abcb8a98b}{probe\_\-obj\_\-getentval} (const \hyperlink{structSEXP}{SEXP\_\-t} $\ast$obj, const char $\ast$name, uint32\_\-t n)
\begin{DoxyCompactList}\small\item\em Get the value of an object's entity. \item\end{DoxyCompactList}\item
int \hyperlink{group__PROBESAPI_gace27f5edf64bb92b2eac845828fc16a8}{probe\_\-obj\_\-getentvals} (const \hyperlink{structSEXP}{SEXP\_\-t} $\ast$obj, const char $\ast$name, uint32\_\-t n, \hyperlink{structSEXP}{SEXP\_\-t} $\ast$$\ast$res)
\begin{DoxyCompactList}\small\item\em Get the list of values of an object's entity. \item\end{DoxyCompactList}\item
\hyperlink{structSEXP}{SEXP\_\-t} $\ast$ \hyperlink{group__PROBESAPI_ga4eff2a5e03886982ddcd3a638656b093}{probe\_\-obj\_\-getattrval} (const \hyperlink{structSEXP}{SEXP\_\-t} $\ast$obj, const char $\ast$name)
\begin{DoxyCompactList}\small\item\em Get the value of an object's attribute. \item\end{DoxyCompactList}\item
bool \hyperlink{group__PROBESAPI_gabdad7653e94bf96bec05941f87257f2e}{probe\_\-obj\_\-attrexists} (const \hyperlink{structSEXP}{SEXP\_\-t} $\ast$obj, const char $\ast$name)
\begin{DoxyCompactList}\small\item\em Check whether the specified attribute exists. \item\end{DoxyCompactList}\item
int \hyperlink{group__PROBESAPI_gabc311067d7dc968de8aa5c640632f015}{probe\_\-obj\_\-setstatus} (\hyperlink{structSEXP}{SEXP\_\-t} $\ast$obj, \hyperlink{group__OVALSYS_gacf14e82865b7254b573e9a98e7fae422}{oval\_\-syschar\_\-status\_\-t} status)
\begin{DoxyCompactList}\small\item\em Set objects's status. \item\end{DoxyCompactList}\item
int \hyperlink{group__PROBESAPI_ga44a9fff23baac451bb3619b619b77690}{probe\_\-objent\_\-setstatus} (\hyperlink{structSEXP}{SEXP\_\-t} $\ast$obj, const char $\ast$name, uint32\_\-t n, \hyperlink{group__OVALSYS_gacf14e82865b7254b573e9a98e7fae422}{oval\_\-syschar\_\-status\_\-t} status)
\begin{DoxyCompactList}\small\item\em Set status of an object's entity. \item\end{DoxyCompactList}\item
char $\ast$ \hyperlink{group__PROBESAPI_ga614b832888ad52140d9a8c2be87d1905}{probe\_\-obj\_\-getname} (const \hyperlink{structSEXP}{SEXP\_\-t} $\ast$obj)
\begin{DoxyCompactList}\small\item\em Get the name of an object. \item\end{DoxyCompactList}\item
size\_\-t \hyperlink{group__PROBESAPI_ga99fcdf7398c070fe503c97b31281289e}{probe\_\-obj\_\-getname\_\-r} (const \hyperlink{structSEXP}{SEXP\_\-t} $\ast$obj, char $\ast$buffer, size\_\-t buflen)
\begin{DoxyCompactList}\small\item\em Get the name of an object. \item\end{DoxyCompactList}\item
\hypertarget{group__PROBESAPI_ga7f9d006aa437b070570283d1226c7448}{
\hyperlink{structSEXP}{SEXP\_\-t} $\ast$ {\bfseries \_\-probe\_\-cobj\_\-new} (\hyperlink{group__OVALSYS_ga6ca9feb1c89087dbae7c7d3074a378c9}{oval\_\-syschar\_\-collection\_\-flag\_\-t} flag, const \hyperlink{structSEXP}{SEXP\_\-t} $\ast$item\_\-list)}
\label{group__PROBESAPI_ga7f9d006aa437b070570283d1226c7448}
\item
\hypertarget{group__PROBESAPI_ga1a2a3e5ca7cb08a2ed46c385cbcb338e}{
\hyperlink{structSEXP}{SEXP\_\-t} $\ast$ {\bfseries \_\-probe\_\-cobj\_\-get\_\-items} (const \hyperlink{structSEXP}{SEXP\_\-t} $\ast$cobj)}
\label{group__PROBESAPI_ga1a2a3e5ca7cb08a2ed46c385cbcb338e}
\item
\hypertarget{group__PROBESAPI_gab02d09de787a051f085c8478029177b7}{
\hyperlink{group__OVALSYS_ga6ca9feb1c89087dbae7c7d3074a378c9}{oval\_\-syschar\_\-collection\_\-flag\_\-t} {\bfseries \_\-probe\_\-cobj\_\-get\_\-flag} (const \hyperlink{structSEXP}{SEXP\_\-t} $\ast$cobj)}
\label{group__PROBESAPI_gab02d09de787a051f085c8478029177b7}
\item
\hypertarget{group__PROBESAPI_gac48053509792b0d65f572c34648961a2}{
\hyperlink{group__OVALSYS_ga6ca9feb1c89087dbae7c7d3074a378c9}{oval\_\-syschar\_\-collection\_\-flag\_\-t} {\bfseries \_\-probe\_\-cobj\_\-combine\_\-flags} (\hyperlink{group__OVALSYS_ga6ca9feb1c89087dbae7c7d3074a378c9}{oval\_\-syschar\_\-collection\_\-flag\_\-t} f1, \hyperlink{group__OVALSYS_ga6ca9feb1c89087dbae7c7d3074a378c9}{oval\_\-syschar\_\-collection\_\-flag\_\-t} f2, \hyperlink{group__OVALDEF_ga695dd73f42848ceb78bc9c9b3794e08c}{oval\_\-setobject\_\-operation\_\-t} op)}
\label{group__PROBESAPI_gac48053509792b0d65f572c34648961a2}
\item
\hyperlink{structSEXP}{SEXP\_\-t} $\ast$ \hyperlink{group__PROBESAPI_ga76a6bb61d3b640748dd5416a349f3bcf}{probe\_\-ent\_\-creat} (const char $\ast$name, \hyperlink{structSEXP}{SEXP\_\-t} $\ast$attrs, \hyperlink{structSEXP}{SEXP\_\-t} $\ast$val,...)
\begin{DoxyCompactList}\small\item\em Create a new list of entities. \item\end{DoxyCompactList}\item
\hyperlink{structSEXP}{SEXP\_\-t} $\ast$ \hyperlink{group__PROBESAPI_ga1203e858ab9fcf9c2d37514626deb9d8}{probe\_\-ent\_\-creat1} (const char $\ast$name, \hyperlink{structSEXP}{SEXP\_\-t} $\ast$attrs, \hyperlink{structSEXP}{SEXP\_\-t} $\ast$val)
\begin{DoxyCompactList}\small\item\em Create a new entity. \item\end{DoxyCompactList}\item
\hyperlink{structSEXP}{SEXP\_\-t} $\ast$ \hyperlink{group__PROBESAPI_ga2c4ae475b5c8156b4436359cb82d14c6}{probe\_\-ent\_\-attr\_\-add} (\hyperlink{structSEXP}{SEXP\_\-t} $\ast$ent, const char $\ast$name, \hyperlink{structSEXP}{SEXP\_\-t} $\ast$val)
\begin{DoxyCompactList}\small\item\em Add a new attribute to an entity. \item\end{DoxyCompactList}\item
\hyperlink{structSEXP}{SEXP\_\-t} $\ast$ \hyperlink{group__PROBESAPI_gaefe143cb0db920b26ca3c20348287f32}{probe\_\-ent\_\-getval} (const \hyperlink{structSEXP}{SEXP\_\-t} $\ast$ent)
\begin{DoxyCompactList}\small\item\em Get the value of an entity. \item\end{DoxyCompactList}\item
int \hyperlink{group__PROBESAPI_ga3ff2cd8dba0ce124e8c1557f83ece7e0}{probe\_\-ent\_\-getvals} (const \hyperlink{structSEXP}{SEXP\_\-t} $\ast$ent, \hyperlink{structSEXP}{SEXP\_\-t} $\ast$$\ast$res)
\begin{DoxyCompactList}\small\item\em Get the list of values of an entity. \item\end{DoxyCompactList}\item
\hyperlink{structSEXP}{SEXP\_\-t} $\ast$ \hyperlink{group__PROBESAPI_gaaa841c5a9ec35e411832d2b77ae73aff}{probe\_\-ent\_\-getattrval} (const \hyperlink{structSEXP}{SEXP\_\-t} $\ast$ent, const char $\ast$name)
\begin{DoxyCompactList}\small\item\em Get the value of an entity's attribute. \item\end{DoxyCompactList}\item
bool \hyperlink{group__PROBESAPI_gade2da190db42b69de3a82df73ddf92da}{probe\_\-ent\_\-attrexists} (const \hyperlink{structSEXP}{SEXP\_\-t} $\ast$ent, const char $\ast$name)
\begin{DoxyCompactList}\small\item\em Check whether the specified attribute exists. \item\end{DoxyCompactList}\item
int \hyperlink{group__PROBESAPI_gabd1dbeb0c28df011d6a2aceb400bf1cb}{probe\_\-ent\_\-setdatatype} (\hyperlink{structSEXP}{SEXP\_\-t} $\ast$ent, \hyperlink{group__OVALDEF_gaf069fe2fb2a9ae3abe47cab55b89827e}{oval\_\-datatype\_\-t} type)
\begin{DoxyCompactList}\small\item\em Set the OVAL data type of an entity. \item\end{DoxyCompactList}\item
\hyperlink{group__OVALDEF_gaf069fe2fb2a9ae3abe47cab55b89827e}{oval\_\-datatype\_\-t} \hyperlink{group__PROBESAPI_ga63df6b0800c386aa946dd79088893f05}{probe\_\-ent\_\-getdatatype} (const \hyperlink{structSEXP}{SEXP\_\-t} $\ast$ent)
\begin{DoxyCompactList}\small\item\em Get the OVAL data type of an entity. \item\end{DoxyCompactList}\item
int \hyperlink{group__PROBESAPI_ga78fa4b2ed51c75dc331f2b30305be587}{probe\_\-ent\_\-setmask} (\hyperlink{structSEXP}{SEXP\_\-t} $\ast$ent, bool mask)
\begin{DoxyCompactList}\small\item\em Set entity's mask. \item\end{DoxyCompactList}\item
bool \hyperlink{group__PROBESAPI_gaa18871c25a66d86317af2998703d3834}{probe\_\-ent\_\-getmask} (const \hyperlink{structSEXP}{SEXP\_\-t} $\ast$ent)
\begin{DoxyCompactList}\small\item\em Get entity's mask. \item\end{DoxyCompactList}\item
int \hyperlink{group__PROBESAPI_ga19a9b8b09ebcb61389d792eeb4a450ee}{probe\_\-ent\_\-setstatus} (\hyperlink{structSEXP}{SEXP\_\-t} $\ast$ent, \hyperlink{group__OVALSYS_gacf14e82865b7254b573e9a98e7fae422}{oval\_\-syschar\_\-status\_\-t} status)
\begin{DoxyCompactList}\small\item\em Set entity's status. \item\end{DoxyCompactList}\item
\hyperlink{group__OVALSYS_gacf14e82865b7254b573e9a98e7fae422}{oval\_\-syschar\_\-status\_\-t} \hyperlink{group__PROBESAPI_gaf6f8c32f4222562df8396b6ce8e8afc0}{probe\_\-ent\_\-getstatus} (const \hyperlink{structSEXP}{SEXP\_\-t} $\ast$ent)
\begin{DoxyCompactList}\small\item\em Get entity status. \item\end{DoxyCompactList}\item
char $\ast$ \hyperlink{group__PROBESAPI_gaa9c1f58c018a3d9df99c8240ba387e93}{probe\_\-ent\_\-getname} (const \hyperlink{structSEXP}{SEXP\_\-t} $\ast$ent)
\begin{DoxyCompactList}\small\item\em Get the name of an entity. \item\end{DoxyCompactList}\item
size\_\-t \hyperlink{group__PROBESAPI_ga8327d5fcb919ace33e748995242121d5}{probe\_\-ent\_\-getname\_\-r} (const \hyperlink{structSEXP}{SEXP\_\-t} $\ast$ent, char $\ast$buffer, size\_\-t buflen)
\begin{DoxyCompactList}\small\item\em Get the name of an entity. \item\end{DoxyCompactList}\item
void \hyperlink{group__PROBESAPI_gaaa9687fb52f3ecba96ea03e71759505c}{probe\_\-free} (\hyperlink{structSEXP}{SEXP\_\-t} $\ast$obj)
\begin{DoxyCompactList}\small\item\em Free the memory allocated by the probe\_\-$\ast$ functions. \item\end{DoxyCompactList}\item
\hypertarget{group__PROBESAPI_gafe95c72e81a54869107bb0b9f9b43427}{
void $\ast$ {\bfseries probe\_\-init} (void) \hyperlink{struct____attribute____}{\_\-\_\-attribute\_\-\_\-}((unused))}
\label{group__PROBESAPI_gafe95c72e81a54869107bb0b9f9b43427}
\item
\hypertarget{group__PROBESAPI_ga60a6e8dd5d034bc5b0fb714016973a2a}{
void {\bfseries probe\_\-fini} (void $\ast$) \hyperlink{struct____attribute____}{\_\-\_\-attribute\_\-\_\-}((unused))}
\label{group__PROBESAPI_ga60a6e8dd5d034bc5b0fb714016973a2a}
\item
\hypertarget{group__PROBESAPI_gae2e7dc51d20d68d2f8a4e656395dc2b2}{
\hyperlink{structSEXP}{SEXP\_\-t} $\ast$ {\bfseries probe\_\-main} (\hyperlink{structSEXP}{SEXP\_\-t} $\ast$, int $\ast$, void $\ast$) \hyperlink{struct____attribute____}{\_\-\_\-attribute\_\-\_\-}((nonnull(1}
\label{group__PROBESAPI_gae2e7dc51d20d68d2f8a4e656395dc2b2}
\end{DoxyCompactItemize}
\subsection{Detailed Description}
Most of the operations that need to be done in a probe, processing input object, manipulating entities, creating output items.
\subsection{Define Documentation}
\hypertarget{group__PROBESAPI_ga60d3eaa56be311e42ca265e1610ba357}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-item\_\-creat@{probe\_\-item\_\-creat}}
\index{probe\_\-item\_\-creat@{probe\_\-item\_\-creat}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-item\_\-creat}]{\setlength{\rightskip}{0pt plus 5cm}\#define probe\_\-item\_\-creat(name, \/ attrs, \/ {\em ...})~probe\_\-obj\_\-creat (name, attrs, \_\-\_\-VA\_\-ARGS\_\-\_\-)}}
\label{group__PROBESAPI_ga60d3eaa56be311e42ca265e1610ba357}
Create a new item consisting of a name, optional attributes argument and an arbitrary number of entities. Every entity is a triple: const char $\ast$name -\/ name of the new entity SEXP\_\-t attrs -\/ optional list of entity attributes in a sexp, can be NULL SEXP\_\-t val -\/ value of the new entity in a sexp This function increments its SEXP\_\-t arguments' reference count.
\begin{DoxyParams}{Parameters}
\item[{\em name}]mandatory name argument \item[{\em attrs}]optional item's attributes argument \item[{\em ...}]arbitrary number of entity arguments \end{DoxyParams}
\subsection{Function Documentation}
\hypertarget{group__PROBESAPI_gaa108cf08d3ad894f06e7eee7c0100047}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-attr\_\-creat@{probe\_\-attr\_\-creat}}
\index{probe\_\-attr\_\-creat@{probe\_\-attr\_\-creat}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-attr\_\-creat}]{\setlength{\rightskip}{0pt plus 5cm}{\bf SEXP\_\-t}$\ast$ probe\_\-attr\_\-creat (const char $\ast$ {\em name}, \/ const {\bf SEXP\_\-t} $\ast$ {\em val}, \/ {\em ...})}}
\label{group__PROBESAPI_gaa108cf08d3ad894f06e7eee7c0100047}
Create a new list of attributes. This function increments its val argument's reference count.
\begin{DoxyParams}{Parameters}
\item[{\em name}]the name of the attribute \item[{\em val}]the value of the attribute \item[{\em ...}]there can be an arbitrary number of name -\/ value pairs \end{DoxyParams}
\hypertarget{group__PROBESAPI_ga2c4ae475b5c8156b4436359cb82d14c6}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-ent\_\-attr\_\-add@{probe\_\-ent\_\-attr\_\-add}}
\index{probe\_\-ent\_\-attr\_\-add@{probe\_\-ent\_\-attr\_\-add}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-ent\_\-attr\_\-add}]{\setlength{\rightskip}{0pt plus 5cm}{\bf SEXP\_\-t}$\ast$ probe\_\-ent\_\-attr\_\-add ({\bf SEXP\_\-t} $\ast$ {\em ent}, \/ const char $\ast$ {\em name}, \/ {\bf SEXP\_\-t} $\ast$ {\em val})}}
\label{group__PROBESAPI_ga2c4ae475b5c8156b4436359cb82d14c6}
Add a new attribute to an entity. This function increments its val argument's reference count.
\begin{DoxyParams}{Parameters}
\item[{\em ent}]the entity to be modified \item[{\em name}]name of the new attribute \item[{\em val}]value of the new attribute \end{DoxyParams}
\hypertarget{group__PROBESAPI_gade2da190db42b69de3a82df73ddf92da}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-ent\_\-attrexists@{probe\_\-ent\_\-attrexists}}
\index{probe\_\-ent\_\-attrexists@{probe\_\-ent\_\-attrexists}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-ent\_\-attrexists}]{\setlength{\rightskip}{0pt plus 5cm}bool probe\_\-ent\_\-attrexists (const {\bf SEXP\_\-t} $\ast$ {\em ent}, \/ const char $\ast$ {\em name})}}
\label{group__PROBESAPI_gade2da190db42b69de3a82df73ddf92da}
Check whether the specified attribute exists.
\begin{DoxyParams}{Parameters}
\item[{\em ent}]the queried entity \item[{\em name}]the name of the attribute \end{DoxyParams}
\hypertarget{group__PROBESAPI_ga76a6bb61d3b640748dd5416a349f3bcf}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-ent\_\-creat@{probe\_\-ent\_\-creat}}
\index{probe\_\-ent\_\-creat@{probe\_\-ent\_\-creat}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-ent\_\-creat}]{\setlength{\rightskip}{0pt plus 5cm}{\bf SEXP\_\-t}$\ast$ probe\_\-ent\_\-creat (const char $\ast$ {\em name}, \/ {\bf SEXP\_\-t} $\ast$ {\em attrs}, \/ {\bf SEXP\_\-t} $\ast$ {\em val}, \/ {\em ...})}}
\label{group__PROBESAPI_ga76a6bb61d3b640748dd5416a349f3bcf}
Create a new list of entities. This function increments its SEXP\_\-t arguments' reference count.
\begin{DoxyParams}{Parameters}
\item[{\em name}]the name of the entity \item[{\em attrs}]optional entity's attributes argument \item[{\em val}]the value of the entity \item[{\em ...}]there can be an arbitrary number of name -\/ attributes -\/ value triples \end{DoxyParams}
\hypertarget{group__PROBESAPI_ga1203e858ab9fcf9c2d37514626deb9d8}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-ent\_\-creat1@{probe\_\-ent\_\-creat1}}
\index{probe\_\-ent\_\-creat1@{probe\_\-ent\_\-creat1}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-ent\_\-creat1}]{\setlength{\rightskip}{0pt plus 5cm}{\bf SEXP\_\-t}$\ast$ probe\_\-ent\_\-creat1 (const char $\ast$ {\em name}, \/ {\bf SEXP\_\-t} $\ast$ {\em attrs}, \/ {\bf SEXP\_\-t} $\ast$ {\em val})}}
\label{group__PROBESAPI_ga1203e858ab9fcf9c2d37514626deb9d8}
Create a new entity. This function increments its SEXP\_\-t arguments' reference count.
\begin{DoxyParams}{Parameters}
\item[{\em name}]the name of the entity \item[{\em attrs}]optional entity's attributes argument \item[{\em val}]the value of the entity \end{DoxyParams}
\hypertarget{group__PROBESAPI_gaaa841c5a9ec35e411832d2b77ae73aff}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-ent\_\-getattrval@{probe\_\-ent\_\-getattrval}}
\index{probe\_\-ent\_\-getattrval@{probe\_\-ent\_\-getattrval}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-ent\_\-getattrval}]{\setlength{\rightskip}{0pt plus 5cm}{\bf SEXP\_\-t}$\ast$ probe\_\-ent\_\-getattrval (const {\bf SEXP\_\-t} $\ast$ {\em ent}, \/ const char $\ast$ {\em name})}}
\label{group__PROBESAPI_gaaa841c5a9ec35e411832d2b77ae73aff}
Get the value of an entity's attribute.
\begin{DoxyParams}{Parameters}
\item[{\em ent}]the queried entity \item[{\em name}]the name of the attribute \end{DoxyParams}
\hypertarget{group__PROBESAPI_ga63df6b0800c386aa946dd79088893f05}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-ent\_\-getdatatype@{probe\_\-ent\_\-getdatatype}}
\index{probe\_\-ent\_\-getdatatype@{probe\_\-ent\_\-getdatatype}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-ent\_\-getdatatype}]{\setlength{\rightskip}{0pt plus 5cm}{\bf oval\_\-datatype\_\-t} probe\_\-ent\_\-getdatatype (const {\bf SEXP\_\-t} $\ast$ {\em ent})}}
\label{group__PROBESAPI_ga63df6b0800c386aa946dd79088893f05}
Get the OVAL data type of an entity.
\begin{DoxyParams}{Parameters}
\item[{\em ent}]the queried entity \end{DoxyParams}
\hypertarget{group__PROBESAPI_gaa18871c25a66d86317af2998703d3834}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-ent\_\-getmask@{probe\_\-ent\_\-getmask}}
\index{probe\_\-ent\_\-getmask@{probe\_\-ent\_\-getmask}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-ent\_\-getmask}]{\setlength{\rightskip}{0pt plus 5cm}bool probe\_\-ent\_\-getmask (const {\bf SEXP\_\-t} $\ast$ {\em ent})}}
\label{group__PROBESAPI_gaa18871c25a66d86317af2998703d3834}
Get entity's mask.
\begin{DoxyParams}{Parameters}
\item[{\em ent}]the queried entity \end{DoxyParams}
\hypertarget{group__PROBESAPI_gaa9c1f58c018a3d9df99c8240ba387e93}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-ent\_\-getname@{probe\_\-ent\_\-getname}}
\index{probe\_\-ent\_\-getname@{probe\_\-ent\_\-getname}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-ent\_\-getname}]{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ probe\_\-ent\_\-getname (const {\bf SEXP\_\-t} $\ast$ {\em ent})}}
\label{group__PROBESAPI_gaa9c1f58c018a3d9df99c8240ba387e93}
Get the name of an entity.
\begin{DoxyParams}{Parameters}
\item[{\em ent}]the queried entity \end{DoxyParams}
\hypertarget{group__PROBESAPI_ga8327d5fcb919ace33e748995242121d5}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-ent\_\-getname\_\-r@{probe\_\-ent\_\-getname\_\-r}}
\index{probe\_\-ent\_\-getname\_\-r@{probe\_\-ent\_\-getname\_\-r}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-ent\_\-getname\_\-r}]{\setlength{\rightskip}{0pt plus 5cm}size\_\-t probe\_\-ent\_\-getname\_\-r (const {\bf SEXP\_\-t} $\ast$ {\em ent}, \/ char $\ast$ {\em buffer}, \/ size\_\-t {\em buflen})}}
\label{group__PROBESAPI_ga8327d5fcb919ace33e748995242121d5}
Get the name of an entity. The name is stored in the provided buffer.
\begin{DoxyParams}{Parameters}
\item[{\em ent}]the queried entity \item[{\em buffer}]the buffer to store the name in \item[{\em buflen}]the length of the buffer \end{DoxyParams}
\hypertarget{group__PROBESAPI_gaf6f8c32f4222562df8396b6ce8e8afc0}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-ent\_\-getstatus@{probe\_\-ent\_\-getstatus}}
\index{probe\_\-ent\_\-getstatus@{probe\_\-ent\_\-getstatus}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-ent\_\-getstatus}]{\setlength{\rightskip}{0pt plus 5cm}{\bf oval\_\-syschar\_\-status\_\-t} probe\_\-ent\_\-getstatus (const {\bf SEXP\_\-t} $\ast$ {\em ent})}}
\label{group__PROBESAPI_gaf6f8c32f4222562df8396b6ce8e8afc0}
Get entity status.
\begin{DoxyParams}{Parameters}
\item[{\em ent}]the queried entity \end{DoxyParams}
\hypertarget{group__PROBESAPI_gaefe143cb0db920b26ca3c20348287f32}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-ent\_\-getval@{probe\_\-ent\_\-getval}}
\index{probe\_\-ent\_\-getval@{probe\_\-ent\_\-getval}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-ent\_\-getval}]{\setlength{\rightskip}{0pt plus 5cm}{\bf SEXP\_\-t}$\ast$ probe\_\-ent\_\-getval (const {\bf SEXP\_\-t} $\ast$ {\em ent})}}
\label{group__PROBESAPI_gaefe143cb0db920b26ca3c20348287f32}
Get the value of an entity. The function respects the var\_\-ref attribute and returns the currently selected value.
\begin{DoxyParams}{Parameters}
\item[{\em ent}]the queried entity \end{DoxyParams}
\hypertarget{group__PROBESAPI_ga3ff2cd8dba0ce124e8c1557f83ece7e0}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-ent\_\-getvals@{probe\_\-ent\_\-getvals}}
\index{probe\_\-ent\_\-getvals@{probe\_\-ent\_\-getvals}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-ent\_\-getvals}]{\setlength{\rightskip}{0pt plus 5cm}int probe\_\-ent\_\-getvals (const {\bf SEXP\_\-t} $\ast$ {\em ent}, \/ {\bf SEXP\_\-t} $\ast$$\ast$ {\em res})}}
\label{group__PROBESAPI_ga3ff2cd8dba0ce124e8c1557f83ece7e0}
Get the list of values of an entity. If the entity uses var\_\-ref, there can be more than one value.
\begin{DoxyParams}{Parameters}
\item[{\em ent}]the queried entity \item[{\em res}]the resulting value list is stored in this argument \end{DoxyParams}
\begin{DoxyReturn}{Returns}
number of values in the list stored in the res argument
\end{DoxyReturn}
\hypertarget{group__PROBESAPI_gabd1dbeb0c28df011d6a2aceb400bf1cb}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-ent\_\-setdatatype@{probe\_\-ent\_\-setdatatype}}
\index{probe\_\-ent\_\-setdatatype@{probe\_\-ent\_\-setdatatype}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-ent\_\-setdatatype}]{\setlength{\rightskip}{0pt plus 5cm}int probe\_\-ent\_\-setdatatype ({\bf SEXP\_\-t} $\ast$ {\em ent}, \/ {\bf oval\_\-datatype\_\-t} {\em type})}}
\label{group__PROBESAPI_gabd1dbeb0c28df011d6a2aceb400bf1cb}
Set the OVAL data type of an entity.
\begin{DoxyParams}{Parameters}
\item[{\em ent}]the queried entity \item[{\em type}]the new data type \end{DoxyParams}
\hypertarget{group__PROBESAPI_ga78fa4b2ed51c75dc331f2b30305be587}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-ent\_\-setmask@{probe\_\-ent\_\-setmask}}
\index{probe\_\-ent\_\-setmask@{probe\_\-ent\_\-setmask}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-ent\_\-setmask}]{\setlength{\rightskip}{0pt plus 5cm}int probe\_\-ent\_\-setmask ({\bf SEXP\_\-t} $\ast$ {\em ent}, \/ bool {\em mask})}}
\label{group__PROBESAPI_ga78fa4b2ed51c75dc331f2b30305be587}
Set entity's mask.
\begin{DoxyParams}{Parameters}
\item[{\em ent}]the queried entity the new mask \end{DoxyParams}
\hypertarget{group__PROBESAPI_ga19a9b8b09ebcb61389d792eeb4a450ee}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-ent\_\-setstatus@{probe\_\-ent\_\-setstatus}}
\index{probe\_\-ent\_\-setstatus@{probe\_\-ent\_\-setstatus}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-ent\_\-setstatus}]{\setlength{\rightskip}{0pt plus 5cm}int probe\_\-ent\_\-setstatus ({\bf SEXP\_\-t} $\ast$ {\em ent}, \/ {\bf oval\_\-syschar\_\-status\_\-t} {\em status})}}
\label{group__PROBESAPI_ga19a9b8b09ebcb61389d792eeb4a450ee}
Set entity's status.
\begin{DoxyParams}{Parameters}
\item[{\em ent}]the entity to be modified \item[{\em status}]the new status \end{DoxyParams}
\hypertarget{group__PROBESAPI_gaaa9687fb52f3ecba96ea03e71759505c}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-free@{probe\_\-free}}
\index{probe\_\-free@{probe\_\-free}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-free}]{\setlength{\rightskip}{0pt plus 5cm}void probe\_\-free ({\bf SEXP\_\-t} $\ast$ {\em obj})}}
\label{group__PROBESAPI_gaaa9687fb52f3ecba96ea03e71759505c}
Free the memory allocated by the probe\_\-$\ast$ functions.
\begin{DoxyParams}{Parameters}
\item[{\em obj}]the object to be freed \end{DoxyParams}
\hypertarget{group__PROBESAPI_gaaca01da4a1e288ba36f7eec0657f6bbe}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-item\_\-attr\_\-add@{probe\_\-item\_\-attr\_\-add}}
\index{probe\_\-item\_\-attr\_\-add@{probe\_\-item\_\-attr\_\-add}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-item\_\-attr\_\-add}]{\setlength{\rightskip}{0pt plus 5cm}{\bf SEXP\_\-t}$\ast$ probe\_\-item\_\-attr\_\-add ({\bf SEXP\_\-t} $\ast$ {\em item}, \/ const char $\ast$ {\em name}, \/ {\bf SEXP\_\-t} $\ast$ {\em val})}}
\label{group__PROBESAPI_gaaca01da4a1e288ba36f7eec0657f6bbe}
Add a new attribute to an item. This function increments its val argument's reference count.
\begin{DoxyParams}{Parameters}
\item[{\em item}]the item to be modified \item[{\em name}]name of the new attribute \item[{\em val}]value of the new attribute \end{DoxyParams}
\hypertarget{group__PROBESAPI_ga24a0fe6c46c667ee39d0f765630a52df}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-item\_\-build@{probe\_\-item\_\-build}}
\index{probe\_\-item\_\-build@{probe\_\-item\_\-build}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-item\_\-build}]{\setlength{\rightskip}{0pt plus 5cm}{\bf SEXP\_\-t}$\ast$ probe\_\-item\_\-build (const char $\ast$ {\em fmt}, \/ {\em ...})}}
\label{group__PROBESAPI_ga24a0fe6c46c667ee39d0f765630a52df}
Build a new item according to the scpecified format.
\begin{DoxyParams}{Parameters}
\item[{\em fmt}]the desired format \end{DoxyParams}
\hypertarget{group__PROBESAPI_ga2a72992661ed8812d7d17c20a3cdff52}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-item\_\-ent\_\-add@{probe\_\-item\_\-ent\_\-add}}
\index{probe\_\-item\_\-ent\_\-add@{probe\_\-item\_\-ent\_\-add}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-item\_\-ent\_\-add}]{\setlength{\rightskip}{0pt plus 5cm}{\bf SEXP\_\-t}$\ast$ probe\_\-item\_\-ent\_\-add ({\bf SEXP\_\-t} $\ast$ {\em item}, \/ const char $\ast$ {\em name}, \/ {\bf SEXP\_\-t} $\ast$ {\em attrs}, \/ {\bf SEXP\_\-t} $\ast$ {\em val})}}
\label{group__PROBESAPI_ga2a72992661ed8812d7d17c20a3cdff52}
Add a new entity to an item. This function increments its attrs and val arguments' reference count.
\begin{DoxyParams}{Parameters}
\item[{\em item}]the item to be modified \item[{\em name}]name of the new entity \item[{\em attrs}]optional attributes of the new entity \item[{\em val}]value of the new entity \end{DoxyParams}
\hypertarget{group__PROBESAPI_gaf696f498bb0fedacae306ec8a21caa91}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-item\_\-new@{probe\_\-item\_\-new}}
\index{probe\_\-item\_\-new@{probe\_\-item\_\-new}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-item\_\-new}]{\setlength{\rightskip}{0pt plus 5cm}{\bf SEXP\_\-t}$\ast$ probe\_\-item\_\-new (const char $\ast$ {\em name}, \/ {\bf SEXP\_\-t} $\ast$ {\em attrs})}}
\label{group__PROBESAPI_gaf696f498bb0fedacae306ec8a21caa91}
Create a new item with just a name and optional attributes argument.
\begin{DoxyParams}{Parameters}
\item[{\em name}]item's name \item[{\em attrs}]optional attributes argument \end{DoxyParams}
\hypertarget{group__PROBESAPI_ga57a33271acce2f5013c1a66b0f106a0a}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-item\_\-newid@{probe\_\-item\_\-newid}}
\index{probe\_\-item\_\-newid@{probe\_\-item\_\-newid}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-item\_\-newid}]{\setlength{\rightskip}{0pt plus 5cm}{\bf SEXP\_\-t}$\ast$ probe\_\-item\_\-newid (struct {\bf id\_\-desc\_\-t} $\ast$ {\em id\_\-desc})}}
\label{group__PROBESAPI_ga57a33271acce2f5013c1a66b0f106a0a}
Get a new unique id (within a probe) for an item.
\begin{DoxyParams}{Parameters}
\item[{\em id\_\-desc}]pointer to a structure holding the global id context \end{DoxyParams}
\begin{DoxyReturn}{Returns}
a new id
\end{DoxyReturn}
\hypertarget{group__PROBESAPI_gaebff8a78f7110b657f693e919f2583d1}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-item\_\-resetid@{probe\_\-item\_\-resetid}}
\index{probe\_\-item\_\-resetid@{probe\_\-item\_\-resetid}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-item\_\-resetid}]{\setlength{\rightskip}{0pt plus 5cm}void probe\_\-item\_\-resetid (struct {\bf id\_\-desc\_\-t} $\ast$ {\em id\_\-desc})}}
\label{group__PROBESAPI_gaebff8a78f7110b657f693e919f2583d1}
Reset the item id generator.
\begin{DoxyParams}{Parameters}
\item[{\em id\_\-desc}]pointer to a structure holding the global id context \end{DoxyParams}
\hypertarget{group__PROBESAPI_ga816e3a0f4022b42e80adb37e712217a1}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-item\_\-setstatus@{probe\_\-item\_\-setstatus}}
\index{probe\_\-item\_\-setstatus@{probe\_\-item\_\-setstatus}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-item\_\-setstatus}]{\setlength{\rightskip}{0pt plus 5cm}int probe\_\-item\_\-setstatus ({\bf SEXP\_\-t} $\ast$ {\em obj}, \/ {\bf oval\_\-syschar\_\-status\_\-t} {\em status})}}
\label{group__PROBESAPI_ga816e3a0f4022b42e80adb37e712217a1}
Set item's status.
\begin{DoxyParams}{Parameters}
\item[{\em obj}]the item to be modified \item[{\em status}]the new status \end{DoxyParams}
\hypertarget{group__PROBESAPI_gad25f90c27a7f5a76abd4348a2777b138}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-itement\_\-setstatus@{probe\_\-itement\_\-setstatus}}
\index{probe\_\-itement\_\-setstatus@{probe\_\-itement\_\-setstatus}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-itement\_\-setstatus}]{\setlength{\rightskip}{0pt plus 5cm}int probe\_\-itement\_\-setstatus ({\bf SEXP\_\-t} $\ast$ {\em obj}, \/ const char $\ast$ {\em name}, \/ uint32\_\-t {\em n}, \/ {\bf oval\_\-syschar\_\-status\_\-t} {\em status})}}
\label{group__PROBESAPI_gad25f90c27a7f5a76abd4348a2777b138}
Set status of an item's entity.
\begin{DoxyParams}{Parameters}
\item[{\em obj}]the item to be modified \item[{\em name}]the name of the entity \item[{\em n}]select the n-\/th occurence of an entity with the specified name \item[{\em status}]the new status \end{DoxyParams}
\hypertarget{group__PROBESAPI_gabdad7653e94bf96bec05941f87257f2e}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-obj\_\-attrexists@{probe\_\-obj\_\-attrexists}}
\index{probe\_\-obj\_\-attrexists@{probe\_\-obj\_\-attrexists}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-obj\_\-attrexists}]{\setlength{\rightskip}{0pt plus 5cm}bool probe\_\-obj\_\-attrexists (const {\bf SEXP\_\-t} $\ast$ {\em obj}, \/ const char $\ast$ {\em name})}}
\label{group__PROBESAPI_gabdad7653e94bf96bec05941f87257f2e}
Check whether the specified attribute exists.
\begin{DoxyParams}{Parameters}
\item[{\em obj}]the queried object \item[{\em name}]the name of the attribute \end{DoxyParams}
\hypertarget{group__PROBESAPI_gac6a32ee967031ae45ccb7b29806715ed}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-obj\_\-build@{probe\_\-obj\_\-build}}
\index{probe\_\-obj\_\-build@{probe\_\-obj\_\-build}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-obj\_\-build}]{\setlength{\rightskip}{0pt plus 5cm}{\bf SEXP\_\-t}$\ast$ probe\_\-obj\_\-build (const char $\ast$ {\em fmt}, \/ {\em ...})}}
\label{group__PROBESAPI_gac6a32ee967031ae45ccb7b29806715ed}
Build a new object according to the scpecified format.
\begin{DoxyParams}{Parameters}
\item[{\em fmt}]the desired format \end{DoxyParams}
\hypertarget{group__PROBESAPI_ga280020101f5ef03123a7e2ff6a0b282e}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-obj\_\-creat@{probe\_\-obj\_\-creat}}
\index{probe\_\-obj\_\-creat@{probe\_\-obj\_\-creat}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-obj\_\-creat}]{\setlength{\rightskip}{0pt plus 5cm}{\bf SEXP\_\-t}$\ast$ probe\_\-obj\_\-creat (const char $\ast$ {\em name}, \/ {\bf SEXP\_\-t} $\ast$ {\em attrs}, \/ {\em ...})}}
\label{group__PROBESAPI_ga280020101f5ef03123a7e2ff6a0b282e}
Create a new object consisting of a name, optional attributes argument and an arbitrary number of entities. Every entity is a triple: const char $\ast$name -\/ name of the new entity SEXP\_\-t attrs -\/ optional list of entity attributes in a sexp, can be NULL SEXP\_\-t val -\/ value of the new entity in a sexp This function increments its SEXP\_\-t arguments' reference count.
\begin{DoxyParams}{Parameters}
\item[{\em name}]mandatory name argument \item[{\em attrs}]optional object's attributes argument \item[{\em ...}]arbitrary number of entity arguments \end{DoxyParams}
\hypertarget{group__PROBESAPI_ga4eff2a5e03886982ddcd3a638656b093}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-obj\_\-getattrval@{probe\_\-obj\_\-getattrval}}
\index{probe\_\-obj\_\-getattrval@{probe\_\-obj\_\-getattrval}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-obj\_\-getattrval}]{\setlength{\rightskip}{0pt plus 5cm}{\bf SEXP\_\-t}$\ast$ probe\_\-obj\_\-getattrval (const {\bf SEXP\_\-t} $\ast$ {\em obj}, \/ const char $\ast$ {\em name})}}
\label{group__PROBESAPI_ga4eff2a5e03886982ddcd3a638656b093}
Get the value of an object's attribute.
\begin{DoxyParams}{Parameters}
\item[{\em obj}]the queried object \item[{\em name}]the name of the attribute \end{DoxyParams}
\hypertarget{group__PROBESAPI_gac9d092361f39bc8514fcbb0418f47070}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-obj\_\-getent@{probe\_\-obj\_\-getent}}
\index{probe\_\-obj\_\-getent@{probe\_\-obj\_\-getent}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-obj\_\-getent}]{\setlength{\rightskip}{0pt plus 5cm}{\bf SEXP\_\-t}$\ast$ probe\_\-obj\_\-getent (const {\bf SEXP\_\-t} $\ast$ {\em obj}, \/ const char $\ast$ {\em name}, \/ uint32\_\-t {\em n})}}
\label{group__PROBESAPI_gac9d092361f39bc8514fcbb0418f47070}
Get an entity from an object.
\begin{DoxyParams}{Parameters}
\item[{\em obj}]the queried object \item[{\em name}]the name of the entity \item[{\em n}]select the n-\/th occurence of an entity with the specified name \end{DoxyParams}
\hypertarget{group__PROBESAPI_gab73d2c29b3b3657eb4a42c5abcb8a98b}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-obj\_\-getentval@{probe\_\-obj\_\-getentval}}
\index{probe\_\-obj\_\-getentval@{probe\_\-obj\_\-getentval}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-obj\_\-getentval}]{\setlength{\rightskip}{0pt plus 5cm}{\bf SEXP\_\-t}$\ast$ probe\_\-obj\_\-getentval (const {\bf SEXP\_\-t} $\ast$ {\em obj}, \/ const char $\ast$ {\em name}, \/ uint32\_\-t {\em n})}}
\label{group__PROBESAPI_gab73d2c29b3b3657eb4a42c5abcb8a98b}
Get the value of an object's entity. The function respects the var\_\-ref attribute and returns the currently selected value.
\begin{DoxyParams}{Parameters}
\item[{\em obj}]the queried object \item[{\em name}]the name of the entity \item[{\em n}]select the n-\/th occurence of an entity with the specified name \end{DoxyParams}
\hypertarget{group__PROBESAPI_gace27f5edf64bb92b2eac845828fc16a8}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-obj\_\-getentvals@{probe\_\-obj\_\-getentvals}}
\index{probe\_\-obj\_\-getentvals@{probe\_\-obj\_\-getentvals}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-obj\_\-getentvals}]{\setlength{\rightskip}{0pt plus 5cm}int probe\_\-obj\_\-getentvals (const {\bf SEXP\_\-t} $\ast$ {\em obj}, \/ const char $\ast$ {\em name}, \/ uint32\_\-t {\em n}, \/ {\bf SEXP\_\-t} $\ast$$\ast$ {\em res})}}
\label{group__PROBESAPI_gace27f5edf64bb92b2eac845828fc16a8}
Get the list of values of an object's entity. If the entity uses var\_\-ref, there can be more than one value.
\begin{DoxyParams}{Parameters}
\item[{\em obj}]the queried object \item[{\em name}]the name of the entity \item[{\em n}]select the n-\/th occurence of an entity with the specified name \item[{\em res}]the resulting value list is stored in this argument \end{DoxyParams}
\begin{DoxyReturn}{Returns}
number of values in the list stored in the res argument
\end{DoxyReturn}
\hypertarget{group__PROBESAPI_ga614b832888ad52140d9a8c2be87d1905}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-obj\_\-getname@{probe\_\-obj\_\-getname}}
\index{probe\_\-obj\_\-getname@{probe\_\-obj\_\-getname}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-obj\_\-getname}]{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ probe\_\-obj\_\-getname (const {\bf SEXP\_\-t} $\ast$ {\em obj})}}
\label{group__PROBESAPI_ga614b832888ad52140d9a8c2be87d1905}
Get the name of an object.
\begin{DoxyParams}{Parameters}
\item[{\em obj}]the queried object \end{DoxyParams}
\hypertarget{group__PROBESAPI_ga99fcdf7398c070fe503c97b31281289e}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-obj\_\-getname\_\-r@{probe\_\-obj\_\-getname\_\-r}}
\index{probe\_\-obj\_\-getname\_\-r@{probe\_\-obj\_\-getname\_\-r}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-obj\_\-getname\_\-r}]{\setlength{\rightskip}{0pt plus 5cm}size\_\-t probe\_\-obj\_\-getname\_\-r (const {\bf SEXP\_\-t} $\ast$ {\em obj}, \/ char $\ast$ {\em buffer}, \/ size\_\-t {\em buflen})}}
\label{group__PROBESAPI_ga99fcdf7398c070fe503c97b31281289e}
Get the name of an object. The name is stored in the provided buffer.
\begin{DoxyParams}{Parameters}
\item[{\em obj}]the queried object \item[{\em buffer}]the buffer to store the name in \item[{\em buflen}]the length of the buffer \end{DoxyParams}
\hypertarget{group__PROBESAPI_ga2539ca96f41a72a89224318c31a19ba9}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-obj\_\-new@{probe\_\-obj\_\-new}}
\index{probe\_\-obj\_\-new@{probe\_\-obj\_\-new}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-obj\_\-new}]{\setlength{\rightskip}{0pt plus 5cm}{\bf SEXP\_\-t}$\ast$ probe\_\-obj\_\-new (const char $\ast$ {\em name}, \/ {\bf SEXP\_\-t} $\ast$ {\em attrs})}}
\label{group__PROBESAPI_ga2539ca96f41a72a89224318c31a19ba9}
Create a new object with just a name and optional attributes argument. This function increments its SEXP\_\-t argument's reference count.
\begin{DoxyParams}{Parameters}
\item[{\em name}]object's name \item[{\em attrs}]optional attributes argument \end{DoxyParams}
\hypertarget{group__PROBESAPI_gabc311067d7dc968de8aa5c640632f015}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-obj\_\-setstatus@{probe\_\-obj\_\-setstatus}}
\index{probe\_\-obj\_\-setstatus@{probe\_\-obj\_\-setstatus}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-obj\_\-setstatus}]{\setlength{\rightskip}{0pt plus 5cm}int probe\_\-obj\_\-setstatus ({\bf SEXP\_\-t} $\ast$ {\em obj}, \/ {\bf oval\_\-syschar\_\-status\_\-t} {\em status})}}
\label{group__PROBESAPI_gabc311067d7dc968de8aa5c640632f015}
Set objects's status.
\begin{DoxyParams}{Parameters}
\item[{\em obj}]the object to be modified \item[{\em status}]the new status \end{DoxyParams}
\hypertarget{group__PROBESAPI_ga44a9fff23baac451bb3619b619b77690}{
\index{PROBESAPI@{PROBESAPI}!probe\_\-objent\_\-setstatus@{probe\_\-objent\_\-setstatus}}
\index{probe\_\-objent\_\-setstatus@{probe\_\-objent\_\-setstatus}!PROBESAPI@{PROBESAPI}}
\subsubsection[{probe\_\-objent\_\-setstatus}]{\setlength{\rightskip}{0pt plus 5cm}int probe\_\-objent\_\-setstatus ({\bf SEXP\_\-t} $\ast$ {\em obj}, \/ const char $\ast$ {\em name}, \/ uint32\_\-t {\em n}, \/ {\bf oval\_\-syschar\_\-status\_\-t} {\em status})}}
\label{group__PROBESAPI_ga44a9fff23baac451bb3619b619b77690}
Set status of an object's entity.
\begin{DoxyParams}{Parameters}
\item[{\em obj}]the object to be modified \item[{\em name}]the name of the entity \item[{\em n}]select the n-\/th occurence of an entity with the specified name \item[{\em status}]the new status \end{DoxyParams}
