InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IPMStringList Class Referenceabstract

#include <IPMStringList.h>

Inheritance diagram for IPMStringList:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IPMSTRINGLIST }
 

Public Member Functions

virtual void Append (PMString k)=0
 
virtual PMString Get (int32 n)=0
 
virtual int32 Length ()=0
 
virtual void Clear ()=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

This class is used to store a list of PMString objects

Member Function Documentation

virtual void IPMStringList::Append (PMString k)
pure virtual

Use to add a new string

Parameters
k- the new String to be added
virtual void IPMStringList::Clear ()
pure virtual

remove all the entries in the array

virtual PMString IPMStringList::Get (int32 n)
pure virtual

Get the nth PMString

Parameters
n- the string you want (must be less than Length - 1)
Returns
- the string you requested. (if you request a value that is out of range behavior is undefined)
virtual int32 IPMStringList::Length ()
pure virtual

Get the number of strings currently stored

Returns
- The number of integers