IXDocBkOptions Class Reference

#include <IXDocBkOptions.h>

Inheritance diagram for IXDocBkOptions:

Public Types
enum	{ kDefaultIID = IID_IXDOCBKOPTIONS }

Public Member Functions
virtual void	AddOption (const WideString &newVal, const int32 indexWhere)=0
virtual WideString	GetNthOption (const int32 index)=0
virtual int32	GetOptionCount ()=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

From SDK sample; stores options.

See Also

kXDocBkChangeOptionsCmdBoss

kWorkspaceBoss

Member Function Documentation

virtual void IXDocBkOptions::AddOption ( const WideString &  newVal, const int32  indexWhere  )

pure virtual

Append an option to the list. If the index you specify is outwith the length, then it'll get appended to the list

Parameters

newVal	IN new value to add to existing list of options.
indexWhere	IN where you want it in the list of options, zero based.

Implemented in XDocBkOptions.

virtual WideString IXDocBkOptions::GetNthOption ( const int32  index )

pure virtual

Return option at given index in list

Parameters

index

IN zero-based index

Returns

PMString

Implemented in XDocBkOptions.