\hypertarget{a02126}{}\doxysection{AAX\+\_\+\+IACFPage\+Table\+\_\+\+V2 Class Reference}
\label{a02126}\index{AAX\_IACFPageTable\_V2@{AAX\_IACFPageTable\_V2}}


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



Inheritance diagram for AAX\+\_\+\+IACFPage\+Table\+\_\+\+V2\+:
% FIG 0


Collaboration diagram for AAX\+\_\+\+IACFPage\+Table\+\_\+\+V2\+:
% FIG 1


\doxysubsection{Description}
Versioned interface to the host\textquotesingle{}s representation of a plug-\/in instance\textquotesingle{}s page table. \doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02126_a325487a56b579e64a21dcfe1a2b435e9}{Get\+Num\+Parameters\+With\+Name\+Variations}} (int32\+\_\+t \&o\+Num\+Parameter\+Identifiers) const =0
\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02126_ac342780ed3567c75d8a68458f0a4ff0c}{Get\+Name\+Variation\+Parameter\+IDAt\+Index}} (int32\+\_\+t i\+Index, \mbox{\hyperlink{a02330}{AAX\+\_\+\+IString}} \&o\+Parameter\+Identifier) const =0
\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02126_af0c22a440afacf5e9ebeaccab11ecde3}{Get\+Num\+Name\+Variations\+For\+Parameter}} (\mbox{\hyperlink{a00542_ab4e01b971dac1b25632fd9f710dd8f77}{AAX\+\_\+\+CPage\+Table\+Param\+ID}} i\+Parameter\+Identifier, int32\+\_\+t \&o\+Num\+Variations) const =0
\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02126_ab866525f8d8902ed8782dc01087d71ce}{Get\+Parameter\+Name\+Variation\+At\+Index}} (\mbox{\hyperlink{a00542_ab4e01b971dac1b25632fd9f710dd8f77}{AAX\+\_\+\+CPage\+Table\+Param\+ID}} i\+Parameter\+Identifier, int32\+\_\+t i\+Index, \mbox{\hyperlink{a02330}{AAX\+\_\+\+IString}} \&o\+Name\+Variation, int32\+\_\+t \&o\+Length) const =0
\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02126_ac4de2771c4025a98f83b89fc6104d9b0}{Get\+Parameter\+Name\+Variation\+Of\+Length}} (\mbox{\hyperlink{a00542_ab4e01b971dac1b25632fd9f710dd8f77}{AAX\+\_\+\+CPage\+Table\+Param\+ID}} i\+Parameter\+Identifier, int32\+\_\+t i\+Length, \mbox{\hyperlink{a02330}{AAX\+\_\+\+IString}} \&o\+Name\+Variation) const =0
\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02126_ada210c1f77658103f2796ae3011bc603}{Clear\+Parameter\+Name\+Variations}} ()=0
\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02126_af03ce323e3ad6bcfe3b11627698b43c7}{Clear\+Name\+Variations\+For\+Parameter}} (\mbox{\hyperlink{a00542_ab4e01b971dac1b25632fd9f710dd8f77}{AAX\+\_\+\+CPage\+Table\+Param\+ID}} i\+Parameter\+Identifier)=0
\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02126_ac4e03c26b8423c49228d0011bf348e11}{Set\+Parameter\+Name\+Variation}} (\mbox{\hyperlink{a00542_ab4e01b971dac1b25632fd9f710dd8f77}{AAX\+\_\+\+CPage\+Table\+Param\+ID}} i\+Parameter\+Identifier, const \mbox{\hyperlink{a02330}{AAX\+\_\+\+IString}} \&i\+Name\+Variation, int32\+\_\+t i\+Length)=0
\end{DoxyCompactItemize}
\doxysubsubsection*{Public Member Functions inherited from \mbox{\hyperlink{a02122}{AAX\+\_\+\+IACFPage\+Table}}}
\begin{DoxyCompactItemize}
\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02122_a664fd7f2edd4f258f258541c85cf3a30}{Clear}} ()=0
\begin{DoxyCompactList}\small\item\em Clears all parameter mappings from the table.   \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02122_ac76672810be58fb013c193ba50170f53}{Empty}} (\mbox{\hyperlink{a00542_aa216506530f1d19a2965931ced2b274b}{AAX\+\_\+\+CBoolean}} \&o\+Empty) const =0
\begin{DoxyCompactList}\small\item\em Indicates whether the table is empty.   \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02122_a8c86b0cfe2d9cfe8b745c09ccf2d8619}{Get\+Num\+Pages}} (int32\+\_\+t \&o\+Num\+Pages) const =0
\begin{DoxyCompactList}\small\item\em Get the number of pages currently in this table.   \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02122_aed3706e4e59c9cf58603db7d06888c81}{Insert\+Page}} (int32\+\_\+t i\+Page)=0
\begin{DoxyCompactList}\small\item\em Insert a new empty page before the page at index {\ttfamily i\+Page}.   \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02122_a111b8371211623bf0c73e6fe8e77c82c}{Remove\+Page}} (int32\+\_\+t i\+Page)=0
\begin{DoxyCompactList}\small\item\em Remove the page at index {\ttfamily i\+Page}.   \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02122_a5fe90fe5ca247a2111ff8892861daefb}{Get\+Num\+Mapped\+Parameter\+IDs}} (int32\+\_\+t i\+Page, int32\+\_\+t \&o\+Num\+Parameter\+Identifiers) const =0
\begin{DoxyCompactList}\small\item\em Returns the total number of parameter IDs which are mapped to a page.   \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02122_a15914845dbf7bc309f07f11b05e89016}{Clear\+Mapped\+Parameter}} (int32\+\_\+t i\+Page, int32\+\_\+t i\+Index)=0
\begin{DoxyCompactList}\small\item\em Clear the parameter at a particular index in this table.   \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02122_ae46125c9ca6f75f5a7bfbf523506c2b7}{Get\+Mapped\+Parameter\+ID}} (int32\+\_\+t i\+Page, int32\+\_\+t i\+Index, \mbox{\hyperlink{a02330}{AAX\+\_\+\+IString}} \&o\+Parameter\+Identifier) const =0
\begin{DoxyCompactList}\small\item\em Get the parameter identifier which is currently mapped to an index in this table.   \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} \mbox{\hyperlink{a02122_a7897faf269ab1d6aa56fcf463fbac783}{Map\+Parameter\+ID}} (\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\+\_\+\+CParam\+ID}} i\+Parameter\+Identifier, int32\+\_\+t i\+Page, int32\+\_\+t i\+Index)=0
\begin{DoxyCompactList}\small\item\em Map a parameter to this table.   \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Public Member Functions inherited from \mbox{\hyperlink{a01770}{IACFUnknown}}}
\begin{DoxyCompactItemize}
\item 
virtual BEGIN\+\_\+\+ACFINTERFACE ACFRESULT ACFMETHODCALLTYPE \mbox{\hyperlink{a01770_a8b7f0ae9c78d007ca76aa462ebe53135}{Query\+Interface}} (const \mbox{\hyperlink{a00308_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{a01770_aa9c7a5b9dff341092b7b86bb9b3a58fb}{Add\+Ref}} (void)=0
\begin{DoxyCompactList}\small\item\em Increments reference count. \end{DoxyCompactList}\item 
virtual acf\+UInt32 ACFMETHODCALLTYPE \mbox{\hyperlink{a01770_afabd38cec0a9ed37f1d3e8644a70ac41}{Release}} (void)=0
\begin{DoxyCompactList}\small\item\em Decrements reference count. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{a02126_a325487a56b579e64a21dcfe1a2b435e9}\label{a02126_a325487a56b579e64a21dcfe1a2b435e9}} 
\index{AAX\_IACFPageTable\_V2@{AAX\_IACFPageTable\_V2}!GetNumParametersWithNameVariations@{GetNumParametersWithNameVariations}}
\index{GetNumParametersWithNameVariations@{GetNumParametersWithNameVariations}!AAX\_IACFPageTable\_V2@{AAX\_IACFPageTable\_V2}}
\doxysubsubsection{\texorpdfstring{GetNumParametersWithNameVariations()}{GetNumParametersWithNameVariations()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFPage\+Table\+\_\+\+V2\+::\+Get\+Num\+Parameters\+With\+Name\+Variations (\begin{DoxyParamCaption}\item[{int32\+\_\+t \&}]{o\+Num\+Parameter\+Identifiers }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}





Get the number of parameters with name variations defined for the current table type

Provides the number of parameters with {\ttfamily lt;Control\+Name\+Variationslt;} which are explicitly defined for the current page table type.

\begin{DoxyNote}{Note}
Normally parameter name variations are only used with the {\ttfamily \textquotesingle{}Pg\+TL\textquotesingle{}} table type
\end{DoxyNote}

\begin{DoxyItemize}
\item \begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{a02294_ac505024dd195c1965c54acac8f1f3016}{AAX\+\_\+\+IPage\+Table\+::\+Get\+Name\+Variation\+Parameter\+IDAt\+Index()}}
\end{DoxySeeAlso}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ out}}  & {\em o\+Num\+Parameter\+Identifiers} & The number of parameters with name variations explicitly associated with the current table type.   \\
\hline
\end{DoxyParams}

\end{DoxyItemize}\mbox{\Hypertarget{a02126_ac342780ed3567c75d8a68458f0a4ff0c}\label{a02126_ac342780ed3567c75d8a68458f0a4ff0c}} 
\index{AAX\_IACFPageTable\_V2@{AAX\_IACFPageTable\_V2}!GetNameVariationParameterIDAtIndex@{GetNameVariationParameterIDAtIndex}}
\index{GetNameVariationParameterIDAtIndex@{GetNameVariationParameterIDAtIndex}!AAX\_IACFPageTable\_V2@{AAX\_IACFPageTable\_V2}}
\doxysubsubsection{\texorpdfstring{GetNameVariationParameterIDAtIndex()}{GetNameVariationParameterIDAtIndex()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFPage\+Table\+\_\+\+V2\+::\+Get\+Name\+Variation\+Parameter\+IDAt\+Index (\begin{DoxyParamCaption}\item[{int32\+\_\+t}]{i\+Index,  }\item[{\mbox{\hyperlink{a02330}{AAX\+\_\+\+IString}} \&}]{o\+Parameter\+Identifier }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}





Get the identifier for a parameter with name variations defined for the current table type

\begin{DoxyNote}{Note}
Normally parameter name variations are only used with the {\ttfamily \textquotesingle{}Pg\+TL\textquotesingle{}} table type
\end{DoxyNote}

\begin{DoxyItemize}
\item \begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{a02294_ad186d2870ad5c188a7375080e8a7907b}{AAX\+\_\+\+IPage\+Table\+::\+Get\+Num\+Parameters\+With\+Name\+Variations()}}
\end{DoxySeeAlso}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Index} & The target parameter index within the list of parameters with explicit name variations defined for this table type. \\
\hline
\mbox{\texttt{ out}}  & {\em o\+Parameter\+Identifier} & The identifier used for the parameter in the page table name variations list (may be parameter name or ID)   \\
\hline
\end{DoxyParams}

\end{DoxyItemize}\mbox{\Hypertarget{a02126_af0c22a440afacf5e9ebeaccab11ecde3}\label{a02126_af0c22a440afacf5e9ebeaccab11ecde3}} 
\index{AAX\_IACFPageTable\_V2@{AAX\_IACFPageTable\_V2}!GetNumNameVariationsForParameter@{GetNumNameVariationsForParameter}}
\index{GetNumNameVariationsForParameter@{GetNumNameVariationsForParameter}!AAX\_IACFPageTable\_V2@{AAX\_IACFPageTable\_V2}}
\doxysubsubsection{\texorpdfstring{GetNumNameVariationsForParameter()}{GetNumNameVariationsForParameter()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFPage\+Table\+\_\+\+V2\+::\+Get\+Num\+Name\+Variations\+For\+Parameter (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ab4e01b971dac1b25632fd9f710dd8f77}{AAX\+\_\+\+CPage\+Table\+Param\+ID}}}]{i\+Parameter\+Identifier,  }\item[{int32\+\_\+t \&}]{o\+Num\+Variations }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}





Get the number of name variations defined for a parameter

Provides the number of {\ttfamily lt;Control\+Name\+Variationslt;} which are explicitly defined for {\ttfamily i\+Parameter\+Identifier} for the current page table type. No fallback logic is used to resolve this to the list of variations which would actually be used for an attached control surface if no explicit variations are defined for the current table type.

\begin{DoxyNote}{Note}
Normally parameter name variations are only used with the {\ttfamily \textquotesingle{}Pg\+TL\textquotesingle{}} table type
\end{DoxyNote}

\begin{DoxyItemize}
\item \begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{a02294_adffe5a5f2ad548bd4c704508d816d568}{AAX\+\_\+\+IPage\+Table\+::\+Get\+Parameter\+Name\+Variation\+At\+Index()}}
\end{DoxySeeAlso}
\begin{DoxyReturn}{Returns}
\mbox{\hyperlink{a00539_a5f8c7439f3a706c4f8315a9609811937aeddbd1bb67e3a66e6af54a4b4a7a57b3}{AAX\+\_\+\+SUCCESS}} and provides zero to {\ttfamily o\+Num\+Variations} if {\ttfamily i\+Parameter\+Identifier} is not found
\end{DoxyReturn}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Parameter\+Identifier} & The identifier for the parameter \\
\hline
\mbox{\texttt{ out}}  & {\em o\+Num\+Variations} & The number of name variations which are defined for this parameter and explicitly associated with the current table type.   \\
\hline
\end{DoxyParams}

\end{DoxyItemize}\mbox{\Hypertarget{a02126_ab866525f8d8902ed8782dc01087d71ce}\label{a02126_ab866525f8d8902ed8782dc01087d71ce}} 
\index{AAX\_IACFPageTable\_V2@{AAX\_IACFPageTable\_V2}!GetParameterNameVariationAtIndex@{GetParameterNameVariationAtIndex}}
\index{GetParameterNameVariationAtIndex@{GetParameterNameVariationAtIndex}!AAX\_IACFPageTable\_V2@{AAX\_IACFPageTable\_V2}}
\doxysubsubsection{\texorpdfstring{GetParameterNameVariationAtIndex()}{GetParameterNameVariationAtIndex()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFPage\+Table\+\_\+\+V2\+::\+Get\+Parameter\+Name\+Variation\+At\+Index (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ab4e01b971dac1b25632fd9f710dd8f77}{AAX\+\_\+\+CPage\+Table\+Param\+ID}}}]{i\+Parameter\+Identifier,  }\item[{int32\+\_\+t}]{i\+Index,  }\item[{\mbox{\hyperlink{a02330}{AAX\+\_\+\+IString}} \&}]{o\+Name\+Variation,  }\item[{int32\+\_\+t \&}]{o\+Length }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}





Get a parameter name variation from the page table

Only returns {\ttfamily lt;Control\+Name\+Variationslt;} which are explicitly defined for the current page table type. No fallback logic is used to resolve this to the abbreviation which would actually be shown on an attached control surface if no explicit variation is defined for the current table type.

\begin{DoxyNote}{Note}
Normally parameter name variations are only used with the {\ttfamily \textquotesingle{}Pg\+TL\textquotesingle{}} table type
\end{DoxyNote}

\begin{DoxyItemize}
\item \begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{a02294_af8be797a3ec7ed3117e720dd29ea7cc7}{AAX\+\_\+\+IPage\+Table\+::\+Get\+Num\+Name\+Variations\+For\+Parameter()}}
\end{DoxySeeAlso}

\item \begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{a02294_a6ddd61f6ba18b8be8141363d5234ed9d}{AAX\+\_\+\+IPage\+Table\+::\+Get\+Parameter\+Name\+Variation\+Of\+Length()}}
\end{DoxySeeAlso}
\begin{DoxyReturn}{Returns}
\mbox{\hyperlink{a00539_a5f8c7439f3a706c4f8315a9609811937ab7383b0169f6dfa5f86b1fefd6c58ae2}{AAX\+\_\+\+ERROR\+\_\+\+NO\+\_\+\+ABBREVIATED\+\_\+\+PARAMETER\+\_\+\+NAME}} if no suitable variation is defined for this table

\mbox{\hyperlink{a00539_a5f8c7439f3a706c4f8315a9609811937a8dd2fdd469583a046765eae9178678a3}{AAX\+\_\+\+ERROR\+\_\+\+ARGUMENT\+\_\+\+OUT\+\_\+\+OF\+\_\+\+RANGE}} if {\ttfamily i\+Index} is out of range
\end{DoxyReturn}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Parameter\+Identifier} & The identifier for the parameter \\
\hline
\mbox{\texttt{ in}}  & {\em i\+Index} & Index of the name variation \\
\hline
\mbox{\texttt{ out}}  & {\em o\+Name\+Variation} & The name variation, if one is explicitly defined for this table type \\
\hline
\mbox{\texttt{ out}}  & {\em o\+Length} & The length value for this name variation. This corresponds to the variation\textquotesingle{}s {\ttfamily sz} attribute in the page table XML and may be different from the string length of {\ttfamily i\+Name\+Variation}.   \\
\hline
\end{DoxyParams}

\end{DoxyItemize}\mbox{\Hypertarget{a02126_ac4de2771c4025a98f83b89fc6104d9b0}\label{a02126_ac4de2771c4025a98f83b89fc6104d9b0}} 
\index{AAX\_IACFPageTable\_V2@{AAX\_IACFPageTable\_V2}!GetParameterNameVariationOfLength@{GetParameterNameVariationOfLength}}
\index{GetParameterNameVariationOfLength@{GetParameterNameVariationOfLength}!AAX\_IACFPageTable\_V2@{AAX\_IACFPageTable\_V2}}
\doxysubsubsection{\texorpdfstring{GetParameterNameVariationOfLength()}{GetParameterNameVariationOfLength()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFPage\+Table\+\_\+\+V2\+::\+Get\+Parameter\+Name\+Variation\+Of\+Length (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ab4e01b971dac1b25632fd9f710dd8f77}{AAX\+\_\+\+CPage\+Table\+Param\+ID}}}]{i\+Parameter\+Identifier,  }\item[{int32\+\_\+t}]{i\+Length,  }\item[{\mbox{\hyperlink{a02330}{AAX\+\_\+\+IString}} \&}]{o\+Name\+Variation }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}





Get a parameter name variation of a particular length from the page table

Only returns {\ttfamily lt;Control\+Name\+Variationslt;} which are explicitly defined of {\ttfamily i\+Length} for the current page table type. No fallback logic is used to resolve this to the abbreviation which would actually be shown on an attached control surface if no explicit variation is defined for the specified length or current table type.

\begin{DoxyNote}{Note}
Normally parameter name variations are only used with the {\ttfamily \textquotesingle{}Pg\+TL\textquotesingle{}} table type
\end{DoxyNote}

\begin{DoxyItemize}
\item \begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{a02294_adffe5a5f2ad548bd4c704508d816d568}{AAX\+\_\+\+IPage\+Table\+::\+Get\+Parameter\+Name\+Variation\+At\+Index()}}
\end{DoxySeeAlso}
\begin{DoxyReturn}{Returns}
\mbox{\hyperlink{a00539_a5f8c7439f3a706c4f8315a9609811937ab7383b0169f6dfa5f86b1fefd6c58ae2}{AAX\+\_\+\+ERROR\+\_\+\+NO\+\_\+\+ABBREVIATED\+\_\+\+PARAMETER\+\_\+\+NAME}} if no suitable variation is defined for this table
\end{DoxyReturn}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Parameter\+Identifier} & The identifier for the parameter \\
\hline
\mbox{\texttt{ in}}  & {\em i\+Length} & The variation length to check, i.\+e. the {\ttfamily sz} attribute for the name variation in the page table XML \\
\hline
\mbox{\texttt{ out}}  & {\em o\+Name\+Variation} & The name variation, if one is explicitly defined for this table type and {\ttfamily i\+Length}   \\
\hline
\end{DoxyParams}

\end{DoxyItemize}\mbox{\Hypertarget{a02126_ada210c1f77658103f2796ae3011bc603}\label{a02126_ada210c1f77658103f2796ae3011bc603}} 
\index{AAX\_IACFPageTable\_V2@{AAX\_IACFPageTable\_V2}!ClearParameterNameVariations@{ClearParameterNameVariations}}
\index{ClearParameterNameVariations@{ClearParameterNameVariations}!AAX\_IACFPageTable\_V2@{AAX\_IACFPageTable\_V2}}
\doxysubsubsection{\texorpdfstring{ClearParameterNameVariations()}{ClearParameterNameVariations()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFPage\+Table\+\_\+\+V2\+::\+Clear\+Parameter\+Name\+Variations (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}





Clears all name variations for the current page table type

\begin{DoxyNote}{Note}
Normally parameter name variations are only used with the {\ttfamily \textquotesingle{}Pg\+TL\textquotesingle{}} table type
\end{DoxyNote}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{a02294_a00a902ce17c43ae32947dba6088936d2}{AAX\+\_\+\+IPage\+Table\+::\+Clear()}} 

\mbox{\hyperlink{a02294_ae6cf05c366d982e8ea92fea1d98f1d22}{AAX\+\_\+\+IPage\+Table\+::\+Clear\+Name\+Variations\+For\+Parameter()}}   
\end{DoxySeeAlso}
\mbox{\Hypertarget{a02126_af03ce323e3ad6bcfe3b11627698b43c7}\label{a02126_af03ce323e3ad6bcfe3b11627698b43c7}} 
\index{AAX\_IACFPageTable\_V2@{AAX\_IACFPageTable\_V2}!ClearNameVariationsForParameter@{ClearNameVariationsForParameter}}
\index{ClearNameVariationsForParameter@{ClearNameVariationsForParameter}!AAX\_IACFPageTable\_V2@{AAX\_IACFPageTable\_V2}}
\doxysubsubsection{\texorpdfstring{ClearNameVariationsForParameter()}{ClearNameVariationsForParameter()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFPage\+Table\+\_\+\+V2\+::\+Clear\+Name\+Variations\+For\+Parameter (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ab4e01b971dac1b25632fd9f710dd8f77}{AAX\+\_\+\+CPage\+Table\+Param\+ID}}}]{i\+Parameter\+Identifier }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}





Clears all name variations for a single parameter for the current page table type

\begin{DoxyWarning}{Warning}
This will invalidate the list of parameter name variations indices, i.\+e. the parameter identifier associated with each index by \mbox{\hyperlink{a02294_ac505024dd195c1965c54acac8f1f3016}{AAX\+\_\+\+IPage\+Table\+::\+Get\+Name\+Variation\+Parameter\+IDAt\+Index()}}
\end{DoxyWarning}
\begin{DoxyNote}{Note}
Normally parameter name variations are only used with the {\ttfamily \textquotesingle{}Pg\+TL\textquotesingle{}} table type
\end{DoxyNote}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{a02294_a00a902ce17c43ae32947dba6088936d2}{AAX\+\_\+\+IPage\+Table\+::\+Clear()}} 

\mbox{\hyperlink{a02294_a6af3965eaf2baeadef9a44aa9c77ecbb}{AAX\+\_\+\+IPage\+Table\+::\+Clear\+Parameter\+Name\+Variations()}}
\end{DoxySeeAlso}
\begin{DoxyReturn}{Returns}
\mbox{\hyperlink{a00539_a5f8c7439f3a706c4f8315a9609811937aeddbd1bb67e3a66e6af54a4b4a7a57b3}{AAX\+\_\+\+SUCCESS}} and provides zero to {\ttfamily o\+Num\+Variations} if {\ttfamily i\+Parameter\+Identifier} is not found
\end{DoxyReturn}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Parameter\+Identifier} & The identifier for the parameter   \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{a02126_ac4e03c26b8423c49228d0011bf348e11}\label{a02126_ac4e03c26b8423c49228d0011bf348e11}} 
\index{AAX\_IACFPageTable\_V2@{AAX\_IACFPageTable\_V2}!SetParameterNameVariation@{SetParameterNameVariation}}
\index{SetParameterNameVariation@{SetParameterNameVariation}!AAX\_IACFPageTable\_V2@{AAX\_IACFPageTable\_V2}}
\doxysubsubsection{\texorpdfstring{SetParameterNameVariation()}{SetParameterNameVariation()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\+\_\+\+Result}} AAX\+\_\+\+IACFPage\+Table\+\_\+\+V2\+::\+Set\+Parameter\+Name\+Variation (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{a00542_ab4e01b971dac1b25632fd9f710dd8f77}{AAX\+\_\+\+CPage\+Table\+Param\+ID}}}]{i\+Parameter\+Identifier,  }\item[{const \mbox{\hyperlink{a02330}{AAX\+\_\+\+IString}} \&}]{i\+Name\+Variation,  }\item[{int32\+\_\+t}]{i\+Length }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}





Sets a name variation explicitly for the current page table type

This will add a new name variation or overwrite the existing name variation with the same length which is defined for the current table type.

\begin{DoxyWarning}{Warning}
If no name variation previously existed for this parameter then this will invalidate the list of parameter name variations indices, i.\+e. the parameter identifier associated with each index by \mbox{\hyperlink{a02294_ac505024dd195c1965c54acac8f1f3016}{AAX\+\_\+\+IPage\+Table\+::\+Get\+Name\+Variation\+Parameter\+IDAt\+Index()}}
\end{DoxyWarning}
\begin{DoxyNote}{Note}
Normally parameter name variations are only used with the {\ttfamily \textquotesingle{}Pg\+TL\textquotesingle{}} table type
\end{DoxyNote}
\begin{DoxyReturn}{Returns}
AAX\+\_\+\+ERROR\+\_\+\+INVALID\+\_\+\+ARGUMENT if {\ttfamily i\+Name\+Variation} is empty or if {\ttfamily i\+Length} is less than zero
\end{DoxyReturn}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em i\+Parameter\+Identifier} & The identifier for the parameter \\
\hline
\mbox{\texttt{ in}}  & {\em i\+Name\+Variation} & The new parameter name variation \\
\hline
\mbox{\texttt{ in}}  & {\em i\+Length} & The length value for this name variation. This corresponds to the variation\textquotesingle{}s {\ttfamily sz} attribute in the page table XML and is not required to match the length of {\ttfamily i\+Name\+Variation}.   \\
\hline
\end{DoxyParams}


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