\hypertarget{a02113}{}\doxysection{AAX\+\_\+\+IACFPage\+Table\+Controller Class Reference}
\label{a02113}\index{AAX\_IACFPageTableController@{AAX\_IACFPageTableController}}


{\ttfamily \#include $<$AAX\+\_\+\+IACFPage\+Table\+Controller.\+h$>$}



Inheritance diagram for AAX\+\_\+\+IACFPage\+Table\+Controller\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=250pt]{a02112}
\end{center}
\end{figure}


Collaboration diagram for AAX\+\_\+\+IACFPage\+Table\+Controller\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=233pt]{a02111}
\end{center}
\end{figure}


\doxysubsection{Description}
Interface for host operations related to the page tables for this plug-\/in. 

\begin{DoxyNote}{Note}
In the AAX Library, access to this interface is provided through \mbox{\hyperlink{a02201}{AAX\+\_\+\+IController}} 
\end{DoxyNote}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
virtual \mbox{\hyperlink{a00533_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02113_a30b6356226881d6d60fb26aabea19d76}{Copy\+Table\+For\+Effect}} (\mbox{\hyperlink{a00533_ab247c0d8686c14e05cbb567ef276f249}{AAX\+\_\+\+CProperty\+Value}} in\+Manufacturer\+ID, \mbox{\hyperlink{a00533_ab247c0d8686c14e05cbb567ef276f249}{AAX\+\_\+\+CProperty\+Value}} in\+Product\+ID, \mbox{\hyperlink{a00533_ab247c0d8686c14e05cbb567ef276f249}{AAX\+\_\+\+CProperty\+Value}} in\+Plug\+In\+ID, uint32\+\_\+t in\+Table\+Type, int32\+\_\+t in\+Table\+Page\+Size, \mbox{\hyperlink{a01757}{IACFUnknown}} $\ast$o\+Page\+Table) const =0
\item 
virtual \mbox{\hyperlink{a00533_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02113_a75965c6121b8041746e0a39f46d6fa8d}{Copy\+Table\+Of\+Layout\+For\+Effect}} (const char $\ast$in\+Effect\+ID, const char $\ast$in\+Layout\+Name, uint32\+\_\+t in\+Table\+Type, int32\+\_\+t in\+Table\+Page\+Size, \mbox{\hyperlink{a01757}{IACFUnknown}} $\ast$o\+Page\+Table) const =0
\end{DoxyCompactItemize}
\doxysubsubsection*{Public Member Functions inherited from \mbox{\hyperlink{a01757}{IACFUnknown}}}
\begin{DoxyCompactItemize}
\item 
virtual BEGIN\+\_\+\+ACFINTERFACE ACFRESULT ACFMETHODCALLTYPE \mbox{\hyperlink{a01757_a8b7f0ae9c78d007ca76aa462ebe53135}{Query\+Interface}} (const \mbox{\hyperlink{a00305_a59df0b41744eee7a066787aaedf97f67}{acf\+IID}} \&iid, void $\ast$$\ast$pp\+Out)=0
\begin{DoxyCompactList}\small\item\em Returns pointers to supported interfaces. \end{DoxyCompactList}\item 
virtual acf\+UInt32 ACFMETHODCALLTYPE \mbox{\hyperlink{a01757_aa9c7a5b9dff341092b7b86bb9b3a58fb}{Add\+Ref}} (void)=0
\begin{DoxyCompactList}\small\item\em Increments reference count. \end{DoxyCompactList}\item 
virtual acf\+UInt32 ACFMETHODCALLTYPE \mbox{\hyperlink{a01757_afabd38cec0a9ed37f1d3e8644a70ac41}{Release}} (void)=0
\begin{DoxyCompactList}\small\item\em Decrements reference count. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{a02113_a30b6356226881d6d60fb26aabea19d76}\label{a02113_a30b6356226881d6d60fb26aabea19d76}} 
\index{AAX\_IACFPageTableController@{AAX\_IACFPageTableController}!CopyTableForEffect@{CopyTableForEffect}}
\index{CopyTableForEffect@{CopyTableForEffect}!AAX\_IACFPageTableController@{AAX\_IACFPageTableController}}
\doxysubsubsection{\texorpdfstring{CopyTableForEffect()}{CopyTableForEffect()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00533_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFPage\+Table\+Controller\+::\+Copy\+Table\+For\+Effect (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00533_ab247c0d8686c14e05cbb567ef276f249}{AAX\+\_\+\+CProperty\+Value}}}]{in\+Manufacturer\+ID,  }\item[{\mbox{\hyperlink{a00533_ab247c0d8686c14e05cbb567ef276f249}{AAX\+\_\+\+CProperty\+Value}}}]{in\+Product\+ID,  }\item[{\mbox{\hyperlink{a00533_ab247c0d8686c14e05cbb567ef276f249}{AAX\+\_\+\+CProperty\+Value}}}]{in\+Plug\+In\+ID,  }\item[{uint32\+\_\+t}]{in\+Table\+Type,  }\item[{int32\+\_\+t}]{in\+Table\+Page\+Size,  }\item[{\mbox{\hyperlink{a01757}{IACFUnknown}} $\ast$}]{o\+Page\+Table }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}

Copy the current page table data for a particular plug-\/in type.  

The host will reject the copy and return an error if the requested plug-\/in type is unkown, if {\ttfamily in\+Table\+Type} is unknown or if {\ttfamily in\+Table\+Page\+Size} is not a supported size for the given table type.

The host may also restrict plug-\/ins to only copying page table data from certain plug-\/in types, such as plug-\/ins from the same manufacturer or plug-\/in types within the same effect.

See \mbox{\hyperlink{a00916}{Page Table Guide}} for more information about page tables.

\begin{DoxyReturn}{Returns}
\mbox{\hyperlink{a00530_a5f8c7439f3a706c4f8315a9609811937aa77cf0ad2d545c97b095d8bc19a7c969}{AAX\+\_\+\+ERROR\+\_\+\+NULL\+\_\+\+ARGUMENT}} if {\ttfamily o\+Page\+Table} is null

\mbox{\hyperlink{a00530_a5f8c7439f3a706c4f8315a9609811937a7d27a3bd88231e331c98d85f5b10e2eb}{AAX\+\_\+\+ERROR\+\_\+\+INVALID\+\_\+\+ARGUMENT}} if no valid page table mapping can be created due to the specified arguments
\end{DoxyReturn}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Manufacturer\+ID} & \mbox{\hyperlink{a00599_a13e384f22825afd3db6d68395b79ce0da996465cca29a2a15291d1c788ac5728c}{Manufacturer ID}} of the desired plug-\/in type \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Product\+ID} & \mbox{\hyperlink{a00599_a13e384f22825afd3db6d68395b79ce0da3a41fcdff5af1a4fd19dcbca7b1ba6f3}{Product ID}} of the desired plug-\/in type \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Plug\+In\+ID} & Type ID of the desired plug-\/in type (\mbox{\hyperlink{a00599_a13e384f22825afd3db6d68395b79ce0da89ca3dd6e96895cda14976c1b1ceb826}{AAX\+\_\+e\+Property\+\_\+\+Plug\+In\+ID\+\_\+\+Native}}, \mbox{\hyperlink{a00599_a13e384f22825afd3db6d68395b79ce0da75f174df4efbeca86eaada126c1d9214}{AAX\+\_\+e\+Property\+\_\+\+Plug\+In\+ID\+\_\+\+TI}}) \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Table\+Type} & Four-\/char type identifier for the requested table type (e.\+g. {\ttfamily \textquotesingle{}Pg\+TL\textquotesingle{}}, {\ttfamily \textquotesingle{}Av81\textquotesingle{}}, etc.) \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Table\+Page\+Size} & Page size for the requested table. Some tables support multiple page sizes. \\
\hline
\mbox{\texttt{ out}}  & {\em o\+Page\+Table} & The page table object to which the page table data should be copied. {\ttfamily o\+Page\+Table} must support \mbox{\hyperlink{a02105}{AAX\+\_\+\+IACFPage\+Table}}\\
\hline
\end{DoxyParams}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{a02201_adfa3039472002a1df22d11607529ccf2}{AAX\+\_\+\+IController\+::\+Create\+Table\+Copy\+For\+Effect()}} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{a02113_a75965c6121b8041746e0a39f46d6fa8d}\label{a02113_a75965c6121b8041746e0a39f46d6fa8d}} 
\index{AAX\_IACFPageTableController@{AAX\_IACFPageTableController}!CopyTableOfLayoutForEffect@{CopyTableOfLayoutForEffect}}
\index{CopyTableOfLayoutForEffect@{CopyTableOfLayoutForEffect}!AAX\_IACFPageTableController@{AAX\_IACFPageTableController}}
\doxysubsubsection{\texorpdfstring{CopyTableOfLayoutForEffect()}{CopyTableOfLayoutForEffect()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00533_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFPage\+Table\+Controller\+::\+Copy\+Table\+Of\+Layout\+For\+Effect (\begin{DoxyParamCaption}\item[{const char $\ast$}]{in\+Effect\+ID,  }\item[{const char $\ast$}]{in\+Layout\+Name,  }\item[{uint32\+\_\+t}]{in\+Table\+Type,  }\item[{int32\+\_\+t}]{in\+Table\+Page\+Size,  }\item[{\mbox{\hyperlink{a01757}{IACFUnknown}} $\ast$}]{o\+Page\+Table }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}

Copy the current page table data for a particular plug-\/in effect and page table layout.  

The host will reject the copy and return an error if the requested effect ID is unkown or if {\ttfamily in\+Layout\+Name} is not a valid layout name for the page tables registered for the effect.

The host may also restrict plug-\/ins to only copying page table data from certain effects, such as effects registered within the current \mbox{\hyperlink{a00935}{AAX}} plug-\/in bundle.

See \mbox{\hyperlink{a00916}{Page Table Guide}} for more information about page tables.

\begin{DoxyReturn}{Returns}
\mbox{\hyperlink{a00530_a5f8c7439f3a706c4f8315a9609811937aa77cf0ad2d545c97b095d8bc19a7c969}{AAX\+\_\+\+ERROR\+\_\+\+NULL\+\_\+\+ARGUMENT}} if {\ttfamily in\+Effect\+ID}, {\ttfamily in\+Layout\+Name}, or {\ttfamily o\+Page\+Table} is null

\mbox{\hyperlink{a00530_a5f8c7439f3a706c4f8315a9609811937a7d27a3bd88231e331c98d85f5b10e2eb}{AAX\+\_\+\+ERROR\+\_\+\+INVALID\+\_\+\+ARGUMENT}} if no valid page table mapping can be created due to the specified arguments
\end{DoxyReturn}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em in\+Effect\+ID} & Effect ID for the desired effect. See \mbox{\hyperlink{a02189_a5ff114b8c4da2081515186f2faf65c8c}{AAX\+\_\+\+ICollection\+::\+Add\+Effect()}} \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Layout\+Name} & Page table layout name (\char`\"{}name\char`\"{} attribute of the {\ttfamily PTLayout} XML tag) \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Table\+Type} & Four-\/char type identifier for the requested table type (e.\+g. {\ttfamily \textquotesingle{}Pg\+TL\textquotesingle{}}, {\ttfamily \textquotesingle{}Av81\textquotesingle{}}, etc.) \\
\hline
\mbox{\texttt{ in}}  & {\em in\+Table\+Page\+Size} & Page size for the requested table. Some tables support multiple page sizes. \\
\hline
\mbox{\texttt{ out}}  & {\em o\+Page\+Table} & The page table object to which the page table data should be copied. {\ttfamily o\+Page\+Table} must support \mbox{\hyperlink{a02105}{AAX\+\_\+\+IACFPage\+Table}}\\
\hline
\end{DoxyParams}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{a02201_a1ff3a32980181232312409794b206ef7}{AAX\+\_\+\+IController\+::\+Create\+Table\+Copy\+For\+Layout()}} 
\end{DoxySeeAlso}


The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{a00800}{AAX\+\_\+\+IACFPage\+Table\+Controller.\+h}}\end{DoxyCompactItemize}
