KeePass   KeePass Help Center Home KeePass Home | Package Downloads | Flag Translations | Blocks Plugins | Donate Donate  
Home Help Center Home | People Forums | Award Awards | Link Links | Search Search  







IKpCommandLineOption Struct Referenceabstract

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

#include <IKpCommandLineOption.h>

Inheritance diagram for IKpCommandLineOption:
IKpUnknown

Public Member Functions

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

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 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.


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



Documentation generated with Doxygen.




Valid XHTML 1.0 Transitional Document

Get KeePass

Flattr this


KeePass is OSI Certified Open Source Software
Copyright © 2003-2014
Dominik Reichl, [Legal Contact / Imprint] [Disclaimer] [Acknowledgements] [Donate], Downloads hosted at

Get KeePass Password Safe at
SourceForge.net. Fast, secure and Free Open Source software downloads