IKpCommandLineOption Struct Reference

Interface to an object wrapping a command line option. More...

#include <IKpCommandLineOption.h>

Inheritance diagram for IKpCommandLineOption:

List of all members.

Public Member Functions
virtual HRESULT	QueryInterface (REFIID riid, void **ppvObject)=0
	COM infrastructure, provides access to all interfaces supported by this object.
virtual ULONG	AddRef ()=0
	COM infrastructure, increments the reference count for this object.
virtual ULONG	Release ()=0
	COM infrastructure, decrements the reference count for this object and eventually deletes it.
virtual LPCTSTR	GetOptionName ()=0
	Returns the option's name (with which the object was initialized).
virtual BOOL	IsOption (LPCTSTR lpArgument)=0
	Determine whether a given command line argument is in the form of the wrapped option.
virtual LPTSTR	GetOptionValue (LPCTSTR lpArgument)=0
	If the given argument is in the form of the wrapped option, this method returns its value.
virtual DWORD	GetOptionValueOffset ()=0
	Returns the zero-based offset of possible values for this option.

---

Detailed Description

Interface to an object wrapping a command line option.

Use IKpAPI::CreateInstanceEx to create an object providing this interface; use CLSID_KpCommandLineOption as CLSID, 0 as lParamW, and a command line option name string pointer as lParamL.

---

Member Function Documentation

virtual ULONG IKpCommandLineOption::AddRef

(

)

[pure virtual]

COM infrastructure, increments the reference count for this object.

Returns:

Returns the new number of references, only for debugging purposes.

Implements IKpUnknown.

virtual LPCTSTR IKpCommandLineOption::GetOptionName

(

)

[pure virtual]

Returns the option's name (with which the object was initialized).

Returns:

This string is static in KeePass, do not delete it.

virtual LPTSTR IKpCommandLineOption::GetOptionValue

(

LPCTSTR

lpArgument

)

[pure virtual]

If the given argument is in the form of the wrapped option, this method returns its value.

Returns:

The returned string must be deleted using IKpAPI::DeleteArray.

virtual DWORD IKpCommandLineOption::GetOptionValueOffset

(

)

[pure virtual]

Returns the zero-based offset of possible values for this option.

virtual BOOL IKpCommandLineOption::IsOption

(

LPCTSTR

lpArgument

)

[pure virtual]

Determine whether a given command line argument is in the form of the wrapped option.

virtual HRESULT IKpCommandLineOption::QueryInterface	(	REFIID	riid,
		void **	ppvObject
	)			[pure virtual]

COM infrastructure, provides access to all interfaces supported by this object.

Implements IKpUnknown.

virtual ULONG IKpCommandLineOption::Release

(

)

[pure virtual]

COM infrastructure, decrements the reference count for this object and eventually deletes it.

If the number of references reaches zero, the object should delete itself (exception: singletons).

Returns:

Returns the new number of references, only for debugging purposes.

Implements IKpUnknown.

---

The documentation for this struct was generated from the following file:

• IKpCommandLineOption.h