ICusDtLnkOptions Class Reference

#include <ICusDtLnkOptions.h>

Inheritance diagram for ICusDtLnkOptions:

Public Types
enum	{ kDefaultIID = IID_ICUSDTLNKOPTIONS }

Public Member Functions
virtual void	AddKeyValuePair (const WideString &key, const WideString &val)=0
virtual WideString	GetValueFromKey (const WideString &key) const =0
virtual WideString	GetNthKey (const int32 index) const =0
virtual int32	GetKeyValuePairCount () const =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 as set of key-value pairs in some kind of workspace

See Also

kCusDtLnkChangeOptionsCmdBoss

IWorkspace

Member Function Documentation

virtual void ICusDtLnkOptions::AddKeyValuePair ( const WideString &  key, const WideString &  val  )

pure virtual

Append an option to the list.

Parameters

key	the key that should be used to retrieve the value
val	the value to store

Implemented in CusDtLnkOptions.

virtual int32 ICusDtLnkOptions::GetKeyValuePairCount ( ) const

pure virtual

Determine how many options are stored

Returns

int32 representing number of options stored

Implemented in CusDtLnkOptions.

virtual WideString ICusDtLnkOptions::GetNthKey ( const int32  index ) const

pure virtual

Accessor for the nth key to retrieve a stored option

Parameters

index

zero based index

Returns

WideString representing key at given index

Implemented in CusDtLnkOptions.

virtual WideString ICusDtLnkOptions::GetValueFromKey ( const WideString &  key ) const

pure virtual

Return option given its key

Parameters

key	identifies the key to retrieve the stored option

Returns

WideString representing the value given the key

Implemented in CusDtLnkOptions.