Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-release > by-pkgid > d4a6745d7fbd92dfb64dce5e91e08f80 > files > 210

lib64meanwhile1-doc-1.0.2-1mdv2008.1.x86_64.rpm

\hypertarget{mw__srvc__dir_8h}{
\section{mw\_\-srvc\_\-dir.h File Reference}
\label{mw__srvc__dir_8h}\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}}
}


{\tt \#include $<$glib.h$>$}\par
{\tt \#include $<$glib/glist.h$>$}\par
\subsection*{Data Structures}
\begin{CompactItemize}
\item 
struct \hyperlink{structmwDirectoryHandler}{mwDirectoryHandler}
\begin{CompactList}\small\item\em handles asynchronous events for a directory service instance \item\end{CompactList}\item 
struct \hyperlink{structmwDirectoryMember}{mwDirectoryMember}
\end{CompactItemize}
\subsection*{Defines}
\begin{CompactItemize}
\item 
\#define \hyperlink{mw__srvc__dir_8h_d14f85f7524da53701b6815b40bd3031}{\_\-MW\_\-SERV\_\-DIR\_\-H}
\item 
\#define \hyperlink{mw__srvc__dir_8h_9e8e363d3e984cb248f780ecf7c669b7}{DIR\_\-SEARCH\_\-ERROR}~0x00000000
\begin{CompactList}\small\item\em return value of directory searches that fail \item\end{CompactList}\item 
\#define \hyperlink{mw__srvc__dir_8h_3e71e58bfa721b29af1e8e6bea0c210d}{MW\_\-DIRECTORY\_\-IS\_\-NEW}(dir)~MW\_\-DIRECTORY\_\-IS\_\-STATE((dir), mwDirectory\_\-NEW)
\item 
\#define \hyperlink{mw__srvc__dir_8h_59dee2af6e326396710262410a83727b}{MW\_\-DIRECTORY\_\-IS\_\-OPEN}(dir)~MW\_\-DIRECTORY\_\-IS\_\-STATE((dir), mwDirectory\_\-OPEN)
\item 
\#define \hyperlink{mw__srvc__dir_8h_61b98cd6f71f89e50d37d1976c1b7e1f}{MW\_\-DIRECTORY\_\-IS\_\-PENDING}(dir)~MW\_\-DIRECTORY\_\-IS\_\-STATE((dir), mwDirectory\_\-PENDING)
\item 
\#define \hyperlink{mw__srvc__dir_8h_31c29620bbcc76eed48040a16a7c0af1}{MW\_\-DIRECTORY\_\-IS\_\-STATE}(dir, \hyperlink{structmwService_b5adc0f5a0cbeddaece7a4512ec66099}{state})~(mwDirectory\_\-getState(dir) == (\hyperlink{structmwService_b5adc0f5a0cbeddaece7a4512ec66099}{state}))
\item 
\#define \hyperlink{mw__srvc__dir_8h_e09f7e7e838b943ab68103d5be873cf6}{SERVICE\_\-DIRECTORY}~0x0000001a
\end{CompactItemize}
\subsection*{Typedefs}
\begin{CompactItemize}
\item 
typedef void($\ast$ \hyperlink{mw__srvc__dir_8h_81dc6682023f70d8bf2e523fdf37e77e}{mwSearchHandler} )(struct \hyperlink{structmwDirectory}{mwDirectory} $\ast$dir, guint32 code, guint32 offset, GList $\ast$members)
\begin{CompactList}\small\item\em Appropriate function signature for handling directory search results. \item\end{CompactList}\end{CompactItemize}
\subsection*{Enumerations}
\begin{CompactItemize}
\item 
enum \hyperlink{mw__srvc__dir_8h_1f72abe2e707f73a2b29ab1dda42c903}{mwDirectoryMemberType} \{ \par
\hyperlink{mw__srvc__dir_8h_1f72abe2e707f73a2b29ab1dda42c9034df8201340e66f52d8f90300bac9da36}{mwDirectoryMember\_\-USER} =  0x0000, 
\par
\hyperlink{mw__srvc__dir_8h_1f72abe2e707f73a2b29ab1dda42c9032250ec76f552aa18e0e7a74f66573f67}{mwDirectoryMember\_\-GROUP} =  0x0001
 \}
\item 
enum \hyperlink{mw__srvc__dir_8h_60044a1a52101f8cc5b9d6a3b7a4d801}{mwDirectoryState} \{ \par
\hyperlink{mw__srvc__dir_8h_60044a1a52101f8cc5b9d6a3b7a4d801a23fa4280674777515fdf7127a9994ec}{mwDirectory\_\-NEW}, 
\par
\hyperlink{mw__srvc__dir_8h_60044a1a52101f8cc5b9d6a3b7a4d801e8e0e99d2620433b2d7caa87e4f8010a}{mwDirectory\_\-PENDING}, 
\par
\hyperlink{mw__srvc__dir_8h_60044a1a52101f8cc5b9d6a3b7a4d8017dfd76f714ee09bc65c7c83ce3159fe8}{mwDirectory\_\-OPEN}, 
\par
\hyperlink{mw__srvc__dir_8h_60044a1a52101f8cc5b9d6a3b7a4d80110be11afe4f1c5faaeee216827c556ae}{mwDirectory\_\-ERROR}, 
\par
\hyperlink{mw__srvc__dir_8h_60044a1a52101f8cc5b9d6a3b7a4d80149f46e4de9c565c09de4db0a1cb6073f}{mwDirectory\_\-UNKNOWN}
 \}
\end{CompactItemize}
\subsection*{Functions}
\begin{CompactItemize}
\item 
GList $\ast$ \hyperlink{mw__srvc__dir_8h_d19477b511ad0a0240646eeaad26976c}{mwAddressBook\_\-getDirectories} (struct \hyperlink{structmwAddressBook}{mwAddressBook} $\ast$book)
\begin{CompactList}\small\item\em list of directories associated with address book. \item\end{CompactList}\item 
const char $\ast$ \hyperlink{mw__srvc__dir_8h_9be5eacaa47c1b40a6d6e6865a50efb5}{mwAddressBook\_\-getName} (struct \hyperlink{structmwAddressBook}{mwAddressBook} $\ast$book)
\begin{CompactList}\small\item\em the name of the address book \item\end{CompactList}\item 
int \hyperlink{mw__srvc__dir_8h_ee4a5d99e7505d038ce21f5014c8956e}{mwDirectory\_\-destroy} (struct \hyperlink{structmwDirectory}{mwDirectory} $\ast$dir)
\begin{CompactList}\small\item\em close and free the directory, and unassociate it with its owning address book and service \item\end{CompactList}\item 
struct \hyperlink{structmwAddressBook}{mwAddressBook} $\ast$ \hyperlink{mw__srvc__dir_8h_e6814f65378ee93bede00fc3189cc906}{mwDirectory\_\-getAddressBook} (struct \hyperlink{structmwDirectory}{mwDirectory} $\ast$dir)
\begin{CompactList}\small\item\em reference owning address book \item\end{CompactList}\item 
gpointer \hyperlink{mw__srvc__dir_8h_635923e640e1679a7e8ad72da82bd124}{mwDirectory\_\-getClientData} (struct \hyperlink{structmwDirectory}{mwDirectory} $\ast$dir)
\begin{CompactList}\small\item\em reference associated client data \item\end{CompactList}\item 
struct \hyperlink{structmwServiceDirectory}{mwServiceDirectory} $\ast$ \hyperlink{mw__srvc__dir_8h_b1e972026a1b564187df0b94539ad496}{mwDirectory\_\-getService} (struct \hyperlink{structmwDirectory}{mwDirectory} $\ast$dir)
\begin{CompactList}\small\item\em reference owning service \item\end{CompactList}\item 
enum \hyperlink{mw__srvc__dir_8h_60044a1a52101f8cc5b9d6a3b7a4d801}{mwDirectoryState} \hyperlink{mw__srvc__dir_8h_ac64837707b8912f6663943323fc2b91}{mwDirectory\_\-getState} (struct \hyperlink{structmwDirectory}{mwDirectory} $\ast$dir)
\item 
struct \hyperlink{structmwDirectory}{mwDirectory} $\ast$ \hyperlink{mw__srvc__dir_8h_26725adc1b0a0e46f65e5b1fda318678}{mwDirectory\_\-new} (struct \hyperlink{structmwAddressBook}{mwAddressBook} $\ast$book)
\begin{CompactList}\small\item\em allocate a new directory based off the given address book \item\end{CompactList}\item 
int \hyperlink{mw__srvc__dir_8h_d48d6fefb1b5bc3b394f0cd1f705a355}{mwDirectory\_\-next} (struct \hyperlink{structmwDirectory}{mwDirectory} $\ast$dir)
\begin{CompactList}\small\item\em continue a search into its next results \item\end{CompactList}\item 
int \hyperlink{mw__srvc__dir_8h_8b4c2367f50ad288b7a6902d7ea1d3d9}{mwDirectory\_\-open} (struct \hyperlink{structmwDirectory}{mwDirectory} $\ast$dir, \hyperlink{mw__srvc__dir_8h_81dc6682023f70d8bf2e523fdf37e77e}{mwSearchHandler} cb)
\begin{CompactList}\small\item\em initialize a directory. \item\end{CompactList}\item 
int \hyperlink{mw__srvc__dir_8h_f875cf16eb3af5c5ddcf2663f5cb4961}{mwDirectory\_\-previous} (struct \hyperlink{structmwDirectory}{mwDirectory} $\ast$dir)
\begin{CompactList}\small\item\em continue a search into its previous results \item\end{CompactList}\item 
void \hyperlink{mw__srvc__dir_8h_2bdd0844643324c5aeaedff5762a9a24}{mwDirectory\_\-removeClientData} (struct \hyperlink{structmwDirectory}{mwDirectory} $\ast$dir)
\begin{CompactList}\small\item\em remove and cleanup user data \item\end{CompactList}\item 
int \hyperlink{mw__srvc__dir_8h_9dbd426e14906b932c49fc8bf73b05b3}{mwDirectory\_\-search} (struct \hyperlink{structmwDirectory}{mwDirectory} $\ast$dir, const char $\ast$query)
\begin{CompactList}\small\item\em initiate a search on an open directory \item\end{CompactList}\item 
void \hyperlink{mw__srvc__dir_8h_c1f534a4ae485697d28607fb413f8adc}{mwDirectory\_\-setClientData} (struct \hyperlink{structmwDirectory}{mwDirectory} $\ast$dir, gpointer data, GDestroyNotify \hyperlink{structmwService_9b86cc0545150a4fde3ab3060e803e58}{clear})
\begin{CompactList}\small\item\em set client data. \item\end{CompactList}\item 
GList $\ast$ \hyperlink{mw__srvc__dir_8h_48dff54d4ac64af11d3108ca6d6881c0}{mwServiceDirectory\_\-getAddressBooks} (struct \hyperlink{structmwServiceDirectory}{mwServiceDirectory} $\ast$srvc)
\begin{CompactList}\small\item\em most recent list of address books available in service \item\end{CompactList}\item 
GList $\ast$ \hyperlink{mw__srvc__dir_8h_1d42ec96164218c4c632bb75ae055fb9}{mwServiceDirectory\_\-getDirectories} (struct \hyperlink{structmwServiceDirectory}{mwServiceDirectory} $\ast$srvc)
\begin{CompactList}\small\item\em list of directories in the service \item\end{CompactList}\item 
struct \hyperlink{structmwDirectoryHandler}{mwDirectoryHandler} $\ast$ \hyperlink{mw__srvc__dir_8h_dadae841da1783e2c0a9a52d862bfae3}{mwServiceDirectory\_\-getHandler} (struct \hyperlink{structmwServiceDirectory}{mwServiceDirectory} $\ast$srvc)
\begin{CompactList}\small\item\em the handler associated with the service at its creation \item\end{CompactList}\item 
struct \hyperlink{structmwServiceDirectory}{mwServiceDirectory} $\ast$ \hyperlink{mw__srvc__dir_8h_0e56c0fb35eca0aaffcaee3faa53192a}{mwServiceDirectory\_\-new} (struct \hyperlink{structmwSession}{mwSession} $\ast$\hyperlink{structmwService_0c2badd2256155b2bee149fa4b57b7d6}{session}, struct \hyperlink{structmwDirectoryHandler}{mwDirectoryHandler} $\ast$handler)
\begin{CompactList}\small\item\em Allocate a new directory service instance for use with session. \item\end{CompactList}\item 
int \hyperlink{mw__srvc__dir_8h_29a526b9ae82e319c04ac7fb9890bc36}{mwServiceDirectory\_\-refreshAddressBooks} (struct \hyperlink{structmwServiceDirectory}{mwServiceDirectory} $\ast$srvc)
\begin{CompactList}\small\item\em submit a request to obtain an updated list of address books from service \item\end{CompactList}\end{CompactItemize}


\subsection{Define Documentation}
\hypertarget{mw__srvc__dir_8h_d14f85f7524da53701b6815b40bd3031}{
\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!\_\-MW\_\-SERV\_\-DIR\_\-H@{\_\-MW\_\-SERV\_\-DIR\_\-H}}
\index{\_\-MW\_\-SERV\_\-DIR\_\-H@{\_\-MW\_\-SERV\_\-DIR\_\-H}!mw_srvc_dir.h@{mw\_\-srvc\_\-dir.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define \_\-MW\_\-SERV\_\-DIR\_\-H}}
\label{mw__srvc__dir_8h_d14f85f7524da53701b6815b40bd3031}


\hypertarget{mw__srvc__dir_8h_9e8e363d3e984cb248f780ecf7c669b7}{
\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!DIR\_\-SEARCH\_\-ERROR@{DIR\_\-SEARCH\_\-ERROR}}
\index{DIR\_\-SEARCH\_\-ERROR@{DIR\_\-SEARCH\_\-ERROR}!mw_srvc_dir.h@{mw\_\-srvc\_\-dir.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define DIR\_\-SEARCH\_\-ERROR~0x00000000}}
\label{mw__srvc__dir_8h_9e8e363d3e984cb248f780ecf7c669b7}


return value of directory searches that fail 

\hypertarget{mw__srvc__dir_8h_3e71e58bfa721b29af1e8e6bea0c210d}{
\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!MW\_\-DIRECTORY\_\-IS\_\-NEW@{MW\_\-DIRECTORY\_\-IS\_\-NEW}}
\index{MW\_\-DIRECTORY\_\-IS\_\-NEW@{MW\_\-DIRECTORY\_\-IS\_\-NEW}!mw_srvc_dir.h@{mw\_\-srvc\_\-dir.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define MW\_\-DIRECTORY\_\-IS\_\-NEW(dir)~MW\_\-DIRECTORY\_\-IS\_\-STATE((dir), mwDirectory\_\-NEW)}}
\label{mw__srvc__dir_8h_3e71e58bfa721b29af1e8e6bea0c210d}


\hypertarget{mw__srvc__dir_8h_59dee2af6e326396710262410a83727b}{
\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!MW\_\-DIRECTORY\_\-IS\_\-OPEN@{MW\_\-DIRECTORY\_\-IS\_\-OPEN}}
\index{MW\_\-DIRECTORY\_\-IS\_\-OPEN@{MW\_\-DIRECTORY\_\-IS\_\-OPEN}!mw_srvc_dir.h@{mw\_\-srvc\_\-dir.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define MW\_\-DIRECTORY\_\-IS\_\-OPEN(dir)~MW\_\-DIRECTORY\_\-IS\_\-STATE((dir), mwDirectory\_\-OPEN)}}
\label{mw__srvc__dir_8h_59dee2af6e326396710262410a83727b}


\hypertarget{mw__srvc__dir_8h_61b98cd6f71f89e50d37d1976c1b7e1f}{
\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!MW\_\-DIRECTORY\_\-IS\_\-PENDING@{MW\_\-DIRECTORY\_\-IS\_\-PENDING}}
\index{MW\_\-DIRECTORY\_\-IS\_\-PENDING@{MW\_\-DIRECTORY\_\-IS\_\-PENDING}!mw_srvc_dir.h@{mw\_\-srvc\_\-dir.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define MW\_\-DIRECTORY\_\-IS\_\-PENDING(dir)~MW\_\-DIRECTORY\_\-IS\_\-STATE((dir), mwDirectory\_\-PENDING)}}
\label{mw__srvc__dir_8h_61b98cd6f71f89e50d37d1976c1b7e1f}


\hypertarget{mw__srvc__dir_8h_31c29620bbcc76eed48040a16a7c0af1}{
\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!MW\_\-DIRECTORY\_\-IS\_\-STATE@{MW\_\-DIRECTORY\_\-IS\_\-STATE}}
\index{MW\_\-DIRECTORY\_\-IS\_\-STATE@{MW\_\-DIRECTORY\_\-IS\_\-STATE}!mw_srvc_dir.h@{mw\_\-srvc\_\-dir.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define MW\_\-DIRECTORY\_\-IS\_\-STATE(dir, {\bf state})~(mwDirectory\_\-getState(dir) == ({\bf state}))}}
\label{mw__srvc__dir_8h_31c29620bbcc76eed48040a16a7c0af1}


\hypertarget{mw__srvc__dir_8h_e09f7e7e838b943ab68103d5be873cf6}{
\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!SERVICE\_\-DIRECTORY@{SERVICE\_\-DIRECTORY}}
\index{SERVICE\_\-DIRECTORY@{SERVICE\_\-DIRECTORY}!mw_srvc_dir.h@{mw\_\-srvc\_\-dir.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define SERVICE\_\-DIRECTORY~0x0000001a}}
\label{mw__srvc__dir_8h_e09f7e7e838b943ab68103d5be873cf6}




\subsection{Typedef Documentation}
\hypertarget{mw__srvc__dir_8h_81dc6682023f70d8bf2e523fdf37e77e}{
\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!mwSearchHandler@{mwSearchHandler}}
\index{mwSearchHandler@{mwSearchHandler}!mw_srvc_dir.h@{mw\_\-srvc\_\-dir.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}typedef void($\ast$ {\bf mwSearchHandler})(struct {\bf mwDirectory} $\ast$dir, guint32 code, guint32 offset, GList $\ast$members)}}
\label{mw__srvc__dir_8h_81dc6682023f70d8bf2e523fdf37e77e}


Appropriate function signature for handling directory search results. 



\subsection{Enumeration Type Documentation}
\hypertarget{mw__srvc__dir_8h_1f72abe2e707f73a2b29ab1dda42c903}{
\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!mwDirectoryMemberType@{mwDirectoryMemberType}}
\index{mwDirectoryMemberType@{mwDirectoryMemberType}!mw_srvc_dir.h@{mw\_\-srvc\_\-dir.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}enum {\bf mwDirectoryMemberType}}}
\label{mw__srvc__dir_8h_1f72abe2e707f73a2b29ab1dda42c903}


\begin{Desc}
\item[Enumerator: ]\par
\begin{description}
\index{mwDirectoryMember\_\-USER@{mwDirectoryMember\_\-USER}!mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}}\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!mwDirectoryMember\_\-USER@{mwDirectoryMember\_\-USER}}\item[{\em 
\hypertarget{mw__srvc__dir_8h_1f72abe2e707f73a2b29ab1dda42c9034df8201340e66f52d8f90300bac9da36}{
mwDirectoryMember\_\-USER}
\label{mw__srvc__dir_8h_1f72abe2e707f73a2b29ab1dda42c9034df8201340e66f52d8f90300bac9da36}
}]\index{mwDirectoryMember\_\-GROUP@{mwDirectoryMember\_\-GROUP}!mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}}\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!mwDirectoryMember\_\-GROUP@{mwDirectoryMember\_\-GROUP}}\item[{\em 
\hypertarget{mw__srvc__dir_8h_1f72abe2e707f73a2b29ab1dda42c9032250ec76f552aa18e0e7a74f66573f67}{
mwDirectoryMember\_\-GROUP}
\label{mw__srvc__dir_8h_1f72abe2e707f73a2b29ab1dda42c9032250ec76f552aa18e0e7a74f66573f67}
}]\end{description}
\end{Desc}

\hypertarget{mw__srvc__dir_8h_60044a1a52101f8cc5b9d6a3b7a4d801}{
\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!mwDirectoryState@{mwDirectoryState}}
\index{mwDirectoryState@{mwDirectoryState}!mw_srvc_dir.h@{mw\_\-srvc\_\-dir.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}enum {\bf mwDirectoryState}}}
\label{mw__srvc__dir_8h_60044a1a52101f8cc5b9d6a3b7a4d801}


\begin{Desc}
\item[Enumerator: ]\par
\begin{description}
\index{mwDirectory\_\-NEW@{mwDirectory\_\-NEW}!mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}}\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!mwDirectory\_\-NEW@{mwDirectory\_\-NEW}}\item[{\em 
\hypertarget{mw__srvc__dir_8h_60044a1a52101f8cc5b9d6a3b7a4d801a23fa4280674777515fdf7127a9994ec}{
mwDirectory\_\-NEW}
\label{mw__srvc__dir_8h_60044a1a52101f8cc5b9d6a3b7a4d801a23fa4280674777515fdf7127a9994ec}
}]directory is created, but not open \index{mwDirectory\_\-PENDING@{mwDirectory\_\-PENDING}!mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}}\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!mwDirectory\_\-PENDING@{mwDirectory\_\-PENDING}}\item[{\em 
\hypertarget{mw__srvc__dir_8h_60044a1a52101f8cc5b9d6a3b7a4d801e8e0e99d2620433b2d7caa87e4f8010a}{
mwDirectory\_\-PENDING}
\label{mw__srvc__dir_8h_60044a1a52101f8cc5b9d6a3b7a4d801e8e0e99d2620433b2d7caa87e4f8010a}
}]directory has in the process of opening \index{mwDirectory\_\-OPEN@{mwDirectory\_\-OPEN}!mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}}\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!mwDirectory\_\-OPEN@{mwDirectory\_\-OPEN}}\item[{\em 
\hypertarget{mw__srvc__dir_8h_60044a1a52101f8cc5b9d6a3b7a4d8017dfd76f714ee09bc65c7c83ce3159fe8}{
mwDirectory\_\-OPEN}
\label{mw__srvc__dir_8h_60044a1a52101f8cc5b9d6a3b7a4d8017dfd76f714ee09bc65c7c83ce3159fe8}
}]directory is open \index{mwDirectory\_\-ERROR@{mwDirectory\_\-ERROR}!mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}}\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!mwDirectory\_\-ERROR@{mwDirectory\_\-ERROR}}\item[{\em 
\hypertarget{mw__srvc__dir_8h_60044a1a52101f8cc5b9d6a3b7a4d80110be11afe4f1c5faaeee216827c556ae}{
mwDirectory\_\-ERROR}
\label{mw__srvc__dir_8h_60044a1a52101f8cc5b9d6a3b7a4d80110be11afe4f1c5faaeee216827c556ae}
}]error opening or using directory \index{mwDirectory\_\-UNKNOWN@{mwDirectory\_\-UNKNOWN}!mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}}\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!mwDirectory\_\-UNKNOWN@{mwDirectory\_\-UNKNOWN}}\item[{\em 
\hypertarget{mw__srvc__dir_8h_60044a1a52101f8cc5b9d6a3b7a4d80149f46e4de9c565c09de4db0a1cb6073f}{
mwDirectory\_\-UNKNOWN}
\label{mw__srvc__dir_8h_60044a1a52101f8cc5b9d6a3b7a4d80149f46e4de9c565c09de4db0a1cb6073f}
}]error determining directory state \end{description}
\end{Desc}



\subsection{Function Documentation}
\hypertarget{mw__srvc__dir_8h_d19477b511ad0a0240646eeaad26976c}{
\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!mwAddressBook\_\-getDirectories@{mwAddressBook\_\-getDirectories}}
\index{mwAddressBook\_\-getDirectories@{mwAddressBook\_\-getDirectories}!mw_srvc_dir.h@{mw\_\-srvc\_\-dir.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}GList$\ast$ mwAddressBook\_\-getDirectories (struct {\bf mwAddressBook} $\ast$ {\em book})}}
\label{mw__srvc__dir_8h_d19477b511ad0a0240646eeaad26976c}


list of directories associated with address book. 

Note that the returned GList will need to be free'd after use \hypertarget{mw__srvc__dir_8h_9be5eacaa47c1b40a6d6e6865a50efb5}{
\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!mwAddressBook\_\-getName@{mwAddressBook\_\-getName}}
\index{mwAddressBook\_\-getName@{mwAddressBook\_\-getName}!mw_srvc_dir.h@{mw\_\-srvc\_\-dir.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const char$\ast$ mwAddressBook\_\-getName (struct {\bf mwAddressBook} $\ast$ {\em book})}}
\label{mw__srvc__dir_8h_9be5eacaa47c1b40a6d6e6865a50efb5}


the name of the address book 

\hypertarget{mw__srvc__dir_8h_ee4a5d99e7505d038ce21f5014c8956e}{
\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!mwDirectory\_\-destroy@{mwDirectory\_\-destroy}}
\index{mwDirectory\_\-destroy@{mwDirectory\_\-destroy}!mw_srvc_dir.h@{mw\_\-srvc\_\-dir.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int mwDirectory\_\-destroy (struct {\bf mwDirectory} $\ast$ {\em dir})}}
\label{mw__srvc__dir_8h_ee4a5d99e7505d038ce21f5014c8956e}


close and free the directory, and unassociate it with its owning address book and service 

\hypertarget{mw__srvc__dir_8h_e6814f65378ee93bede00fc3189cc906}{
\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!mwDirectory\_\-getAddressBook@{mwDirectory\_\-getAddressBook}}
\index{mwDirectory\_\-getAddressBook@{mwDirectory\_\-getAddressBook}!mw_srvc_dir.h@{mw\_\-srvc\_\-dir.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}struct {\bf mwAddressBook}$\ast$ mwDirectory\_\-getAddressBook (struct {\bf mwDirectory} $\ast$ {\em dir})\hspace{0.3cm}{\tt  \mbox{[}read\mbox{]}}}}
\label{mw__srvc__dir_8h_e6814f65378ee93bede00fc3189cc906}


reference owning address book 

\hypertarget{mw__srvc__dir_8h_635923e640e1679a7e8ad72da82bd124}{
\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!mwDirectory\_\-getClientData@{mwDirectory\_\-getClientData}}
\index{mwDirectory\_\-getClientData@{mwDirectory\_\-getClientData}!mw_srvc_dir.h@{mw\_\-srvc\_\-dir.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}gpointer mwDirectory\_\-getClientData (struct {\bf mwDirectory} $\ast$ {\em dir})}}
\label{mw__srvc__dir_8h_635923e640e1679a7e8ad72da82bd124}


reference associated client data 

\hypertarget{mw__srvc__dir_8h_b1e972026a1b564187df0b94539ad496}{
\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!mwDirectory\_\-getService@{mwDirectory\_\-getService}}
\index{mwDirectory\_\-getService@{mwDirectory\_\-getService}!mw_srvc_dir.h@{mw\_\-srvc\_\-dir.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}struct {\bf mwServiceDirectory}$\ast$ mwDirectory\_\-getService (struct {\bf mwDirectory} $\ast$ {\em dir})\hspace{0.3cm}{\tt  \mbox{[}read\mbox{]}}}}
\label{mw__srvc__dir_8h_b1e972026a1b564187df0b94539ad496}


reference owning service 

\hypertarget{mw__srvc__dir_8h_ac64837707b8912f6663943323fc2b91}{
\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!mwDirectory\_\-getState@{mwDirectory\_\-getState}}
\index{mwDirectory\_\-getState@{mwDirectory\_\-getState}!mw_srvc_dir.h@{mw\_\-srvc\_\-dir.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}enum {\bf mwDirectoryState} mwDirectory\_\-getState (struct {\bf mwDirectory} $\ast$ {\em dir})}}
\label{mw__srvc__dir_8h_ac64837707b8912f6663943323fc2b91}


\hypertarget{mw__srvc__dir_8h_26725adc1b0a0e46f65e5b1fda318678}{
\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!mwDirectory\_\-new@{mwDirectory\_\-new}}
\index{mwDirectory\_\-new@{mwDirectory\_\-new}!mw_srvc_dir.h@{mw\_\-srvc\_\-dir.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}struct {\bf mwDirectory}$\ast$ mwDirectory\_\-new (struct {\bf mwAddressBook} $\ast$ {\em book})\hspace{0.3cm}{\tt  \mbox{[}read\mbox{]}}}}
\label{mw__srvc__dir_8h_26725adc1b0a0e46f65e5b1fda318678}


allocate a new directory based off the given address book 

\hypertarget{mw__srvc__dir_8h_d48d6fefb1b5bc3b394f0cd1f705a355}{
\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!mwDirectory\_\-next@{mwDirectory\_\-next}}
\index{mwDirectory\_\-next@{mwDirectory\_\-next}!mw_srvc_dir.h@{mw\_\-srvc\_\-dir.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int mwDirectory\_\-next (struct {\bf mwDirectory} $\ast$ {\em dir})}}
\label{mw__srvc__dir_8h_d48d6fefb1b5bc3b394f0cd1f705a355}


continue a search into its next results 

\hypertarget{mw__srvc__dir_8h_8b4c2367f50ad288b7a6902d7ea1d3d9}{
\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!mwDirectory\_\-open@{mwDirectory\_\-open}}
\index{mwDirectory\_\-open@{mwDirectory\_\-open}!mw_srvc_dir.h@{mw\_\-srvc\_\-dir.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int mwDirectory\_\-open (struct {\bf mwDirectory} $\ast$ {\em dir}, {\bf mwSearchHandler} {\em cb})}}
\label{mw__srvc__dir_8h_8b4c2367f50ad288b7a6902d7ea1d3d9}


initialize a directory. 

\hypertarget{mw__srvc__dir_8h_f875cf16eb3af5c5ddcf2663f5cb4961}{
\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!mwDirectory\_\-previous@{mwDirectory\_\-previous}}
\index{mwDirectory\_\-previous@{mwDirectory\_\-previous}!mw_srvc_dir.h@{mw\_\-srvc\_\-dir.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int mwDirectory\_\-previous (struct {\bf mwDirectory} $\ast$ {\em dir})}}
\label{mw__srvc__dir_8h_f875cf16eb3af5c5ddcf2663f5cb4961}


continue a search into its previous results 

\hypertarget{mw__srvc__dir_8h_2bdd0844643324c5aeaedff5762a9a24}{
\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!mwDirectory\_\-removeClientData@{mwDirectory\_\-removeClientData}}
\index{mwDirectory\_\-removeClientData@{mwDirectory\_\-removeClientData}!mw_srvc_dir.h@{mw\_\-srvc\_\-dir.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void mwDirectory\_\-removeClientData (struct {\bf mwDirectory} $\ast$ {\em dir})}}
\label{mw__srvc__dir_8h_2bdd0844643324c5aeaedff5762a9a24}


remove and cleanup user data 

\hypertarget{mw__srvc__dir_8h_9dbd426e14906b932c49fc8bf73b05b3}{
\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!mwDirectory\_\-search@{mwDirectory\_\-search}}
\index{mwDirectory\_\-search@{mwDirectory\_\-search}!mw_srvc_dir.h@{mw\_\-srvc\_\-dir.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int mwDirectory\_\-search (struct {\bf mwDirectory} $\ast$ {\em dir}, const char $\ast$ {\em query})}}
\label{mw__srvc__dir_8h_9dbd426e14906b932c49fc8bf73b05b3}


initiate a search on an open directory 

\hypertarget{mw__srvc__dir_8h_c1f534a4ae485697d28607fb413f8adc}{
\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!mwDirectory\_\-setClientData@{mwDirectory\_\-setClientData}}
\index{mwDirectory\_\-setClientData@{mwDirectory\_\-setClientData}!mw_srvc_dir.h@{mw\_\-srvc\_\-dir.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void mwDirectory\_\-setClientData (struct {\bf mwDirectory} $\ast$ {\em dir}, gpointer {\em data}, GDestroyNotify {\em clear})}}
\label{mw__srvc__dir_8h_c1f534a4ae485697d28607fb413f8adc}


set client data. 

If there is an existing clear function, it will not be called \hypertarget{mw__srvc__dir_8h_48dff54d4ac64af11d3108ca6d6881c0}{
\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!mwServiceDirectory\_\-getAddressBooks@{mwServiceDirectory\_\-getAddressBooks}}
\index{mwServiceDirectory\_\-getAddressBooks@{mwServiceDirectory\_\-getAddressBooks}!mw_srvc_dir.h@{mw\_\-srvc\_\-dir.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}GList$\ast$ mwServiceDirectory\_\-getAddressBooks (struct {\bf mwServiceDirectory} $\ast$ {\em srvc})}}
\label{mw__srvc__dir_8h_48dff54d4ac64af11d3108ca6d6881c0}


most recent list of address books available in service 

\hypertarget{mw__srvc__dir_8h_1d42ec96164218c4c632bb75ae055fb9}{
\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!mwServiceDirectory\_\-getDirectories@{mwServiceDirectory\_\-getDirectories}}
\index{mwServiceDirectory\_\-getDirectories@{mwServiceDirectory\_\-getDirectories}!mw_srvc_dir.h@{mw\_\-srvc\_\-dir.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}GList$\ast$ mwServiceDirectory\_\-getDirectories (struct {\bf mwServiceDirectory} $\ast$ {\em srvc})}}
\label{mw__srvc__dir_8h_1d42ec96164218c4c632bb75ae055fb9}


list of directories in the service 

\hypertarget{mw__srvc__dir_8h_dadae841da1783e2c0a9a52d862bfae3}{
\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!mwServiceDirectory\_\-getHandler@{mwServiceDirectory\_\-getHandler}}
\index{mwServiceDirectory\_\-getHandler@{mwServiceDirectory\_\-getHandler}!mw_srvc_dir.h@{mw\_\-srvc\_\-dir.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}struct {\bf mwDirectoryHandler}$\ast$ mwServiceDirectory\_\-getHandler (struct {\bf mwServiceDirectory} $\ast$ {\em srvc})\hspace{0.3cm}{\tt  \mbox{[}read\mbox{]}}}}
\label{mw__srvc__dir_8h_dadae841da1783e2c0a9a52d862bfae3}


the handler associated with the service at its creation 

\hypertarget{mw__srvc__dir_8h_0e56c0fb35eca0aaffcaee3faa53192a}{
\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!mwServiceDirectory\_\-new@{mwServiceDirectory\_\-new}}
\index{mwServiceDirectory\_\-new@{mwServiceDirectory\_\-new}!mw_srvc_dir.h@{mw\_\-srvc\_\-dir.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}struct {\bf mwServiceDirectory}$\ast$ mwServiceDirectory\_\-new (struct {\bf mwSession} $\ast$ {\em session}, struct {\bf mwDirectoryHandler} $\ast$ {\em handler})\hspace{0.3cm}{\tt  \mbox{[}read\mbox{]}}}}
\label{mw__srvc__dir_8h_0e56c0fb35eca0aaffcaee3faa53192a}


Allocate a new directory service instance for use with session. 

\hypertarget{mw__srvc__dir_8h_29a526b9ae82e319c04ac7fb9890bc36}{
\index{mw\_\-srvc\_\-dir.h@{mw\_\-srvc\_\-dir.h}!mwServiceDirectory\_\-refreshAddressBooks@{mwServiceDirectory\_\-refreshAddressBooks}}
\index{mwServiceDirectory\_\-refreshAddressBooks@{mwServiceDirectory\_\-refreshAddressBooks}!mw_srvc_dir.h@{mw\_\-srvc\_\-dir.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int mwServiceDirectory\_\-refreshAddressBooks (struct {\bf mwServiceDirectory} $\ast$ {\em srvc})}}
\label{mw__srvc__dir_8h_29a526b9ae82e319c04ac7fb9890bc36}


submit a request to obtain an updated list of address books from service

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional