\section{Soap\-Header Class Reference}
\label{classSoapHeader}\index{SoapHeader@{SoapHeader}}
The Header element information item according to SOAP 1.2 specification. 


{\tt \#include $<$Soap\-Header.h$>$}

Inheritance diagram for Soap\-Header::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2cm]{classSoapHeader}
\end{center}
\end{figure}
\subsection*{Public Methods}
\begin{CompactItemize}
\item 
{\bf IHeader\-Block} $\ast$ {\bf get\-Header\-Block} (const Axis\-Char $\ast$p\-Name, const Axis\-Char $\ast$p\-Namespace, bool b\-Remove\-Or\-Not)
\item 
int {\bf set\-Prefix} (const char $\ast$pc\-Prefix)
\item 
{\bf IHeader\-Block} $\ast$ {\bf get\-Header\-Block} (bool b\-Remove\-Or\-Not)
\item 
int {\bf add\-Namespace\-Decl} ({\bf Attribute} $\ast$p\-Attribute)
\item 
int {\bf add\-Attribute} ({\bf Attribute} $\ast$p\-Attribute)
\item 
void {\bf add\-Header\-Block} (Header\-Block $\ast$header\-Block)
\item 
{\bf Soap\-Header} ()
\item 
virtual {\bf $\sim$Soap\-Header} ()
\end{CompactItemize}


\subsection{Detailed Description}
The Header element information item according to SOAP 1.2 specification.

The Header element information item according to SOAP 1.2 specification. The Header element information item has: 1) A [local name] of Header. 2) A [namespace name] of \char`\"{}{\tt http://www.w3.org/2003/05/soap-envelope}\char`\"{}. 3) Zero or more namespace qualified attribute information items  in its [attributes] property. 4) Zero or more namespace qualified element information items  in its [children] property.

Each child element information item of the SOAP Header is called  a SOAP header block.

\begin{Desc}
\item[Author: ]\par
Roshan Weerasuriya ({\tt roshan@opensource.lk}, {\tt roshanw@jkcsworld.com}) \end{Desc}




\subsection{Constructor \& Destructor Documentation}
\index{SoapHeader@{Soap\-Header}!SoapHeader@{SoapHeader}}
\index{SoapHeader@{SoapHeader}!SoapHeader@{Soap\-Header}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Soap\-Header::Soap\-Header ()}\label{classSoapHeader_a7}


The Constructor. \index{SoapHeader@{Soap\-Header}!~SoapHeader@{$\sim$SoapHeader}}
\index{~SoapHeader@{$\sim$SoapHeader}!SoapHeader@{Soap\-Header}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual Soap\-Header::$\sim$Soap\-Header ()\hspace{0.3cm}{\tt  [virtual]}}\label{classSoapHeader_a8}


The Destructor. 

\subsection{Member Function Documentation}
\index{SoapHeader@{Soap\-Header}!addAttribute@{addAttribute}}
\index{addAttribute@{addAttribute}!SoapHeader@{Soap\-Header}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Soap\-Header::add\-Attribute ({\bf Attribute} $\ast$ {\em p\-Attribute})}\label{classSoapHeader_a4}


Adds a {\bf Attribute} {\rm (p.\,\pageref{classAttribute})} to this Soap Header.\begin{Desc}
\item[Parameters: ]\par
\begin{description}
\item[{\em 
attr}]The {\bf Attribute} {\rm (p.\,\pageref{classAttribute})} to be added. \end{description}
\end{Desc}
\index{SoapHeader@{Soap\-Header}!addHeaderBlock@{addHeaderBlock}}
\index{addHeaderBlock@{addHeaderBlock}!SoapHeader@{Soap\-Header}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Soap\-Header::add\-Header\-Block (Header\-Block $\ast$ {\em header\-Block})}\label{classSoapHeader_a6}


Adds a Header Block to this Soap Header.\begin{Desc}
\item[Parameters: ]\par
\begin{description}
\item[{\em 
header\-Block}]The Header Block to be added. \end{description}
\end{Desc}
\index{SoapHeader@{Soap\-Header}!addNamespaceDecl@{addNamespaceDecl}}
\index{addNamespaceDecl@{addNamespaceDecl}!SoapHeader@{Soap\-Header}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Soap\-Header::add\-Namespace\-Decl ({\bf Attribute} $\ast$ {\em p\-Attribute})}\label{classSoapHeader_a3}


Sets the namespace declaration of the Soap Header.\begin{Desc}
\item[Parameters: ]\par
\begin{description}
\item[{\em 
p\-Attribute}]The {\bf Attribute} {\rm (p.\,\pageref{classAttribute})} pointer which points to a valid  namespace declartion {\bf Attribute} {\rm (p.\,\pageref{classAttribute})}. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns: ]\par
AXIS\_\-SUCCESS to indicate successfull operation. \end{Desc}
\index{SoapHeader@{Soap\-Header}!getHeaderBlock@{getHeaderBlock}}
\index{getHeaderBlock@{getHeaderBlock}!SoapHeader@{Soap\-Header}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf IHeader\-Block}$\ast$ Soap\-Header::get\-Header\-Block (bool {\em b\-Remove\-Or\-Not})}\label{classSoapHeader_a2}


Removes the next Header\-Block from the list and returns it.  But will not delete it. \begin{Desc}
\item[Returns: ]\par
The removed Header\-Block of the list. \end{Desc}
\index{SoapHeader@{Soap\-Header}!getHeaderBlock@{getHeaderBlock}}
\index{getHeaderBlock@{getHeaderBlock}!SoapHeader@{Soap\-Header}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf IHeader\-Block}$\ast$ Soap\-Header::get\-Header\-Block (const Axis\-Char $\ast$ {\em p\-Name}, const Axis\-Char $\ast$ {\em p\-Namespace}, bool {\em b\-Remove\-Or\-Not})}\label{classSoapHeader_a0}


Gets and returns the Header Block, of the given name.\begin{Desc}
\item[Parameters: ]\par
\begin{description}
\item[{\em 
p\-Name}]The local name of the requested Header Block. \item[{\em 
p\-Namespace}]The namespace uri of the requested Header Block. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns: ]\par
A pointer to the requested Header Block will be returned if found or else if not found a NULL pointer will be retured. In case of the requested Header Block is found, also it will be removed from the list of Header Blocks of this Soap Header, before returning a pointer. \end{Desc}
\index{SoapHeader@{Soap\-Header}!setPrefix@{setPrefix}}
\index{setPrefix@{setPrefix}!SoapHeader@{Soap\-Header}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Soap\-Header::set\-Prefix (const char $\ast$ {\em pc\-Prefix})}\label{classSoapHeader_a1}


Sets the Prefix of the Header Block.\begin{Desc}
\item[Parameters: ]\par
\begin{description}
\item[{\em 
pc\-Prefix}]The prefix to set. \end{description}
\end{Desc}


The documentation for this class was generated from the following file:\begin{CompactItemize}
\item 
Soap\-Header.h\end{CompactItemize}
