IKpCommandLine Struct Reference

Interface to a command line handling object. More...

#include <IKpCommandLine.h>

Inheritance diagram for IKpCommandLine:

List of all members.

Public Member Functions
virtual LPCTSTR	GetFullCommandLine ()=0
	Get the complete command line string for the KeePass process.
virtual LPCTSTR	GetExecutablePath ()=0
	Get the path of the KeePass executable file.
virtual LPCTSTR	GetOption (LPCTSTR lpName)=0
	Get a command line option's value.
virtual LPCTSTR	GetMultiOption (LPCTSTR lpName, DWORD dwRelIndex)=0
	Get a command line option's value; for options that may appear multiple times in the command line.
virtual LPCTSTR	GetToken (DWORD dwIndex)=0
	Get a command line token (option name and value).
virtual LPCTSTR	GetTokenRel (LPCTSTR lpName, DWORD dwRelIndex)=0
	Get a command line token (option name and value); tokens are identified relatively by an index into the subset of tokens with the specified command line option name.
virtual LPCTSTR	GetFilePath ()=0
	Get the file path specified on the command line.
virtual LPCTSTR	GetPassword ()=0
	Get the password specified on the command line.
virtual LPCTSTR	GetKeyFilePath ()=0
	Get the key file path specified on the command line.
virtual BOOL	IsPreselectEnabled ()=0
	Returns whether the '-preselect' option is present in the command line or not.
virtual BOOL	IsReadOnlyEnabled ()=0
	Returns whether the '-readonly' option is present in the command line or not.
virtual BOOL	ArgumentBeginsWithPrefix (LPCTSTR lpArgument)=0
	Determine whether an argument begins with a prefix character.

---

Detailed Description

Interface to a command line handling object.

Use IKpAPI::QueryInstance to retrieve an interface to a singleton object in KeePass handling command line queries.

---

Member Function Documentation

virtual BOOL IKpCommandLine::ArgumentBeginsWithPrefix

(

LPCTSTR

lpArgument

)

[pure virtual]

Determine whether an argument begins with a prefix character.

virtual LPCTSTR IKpCommandLine::GetExecutablePath

(

)

[pure virtual]

Get the path of the KeePass executable file.

Returns:

Full executable path.

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

virtual LPCTSTR IKpCommandLine::GetFilePath

(

)

[pure virtual]

Get the file path specified on the command line.

This typically is a path to a KDB database file.

Returns:

Full path to the file. If no file has been specified, the string is empty.

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

virtual LPCTSTR IKpCommandLine::GetFullCommandLine

(

)

[pure virtual]

Get the complete command line string for the KeePass process.

Returns:

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

virtual LPCTSTR IKpCommandLine::GetKeyFilePath

(

)

[pure virtual]

Get the key file path specified on the command line.

Returns:

The key file path.

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

virtual LPCTSTR IKpCommandLine::GetMultiOption	(	LPCTSTR	lpName,
		DWORD	dwRelIndex
	)			[pure virtual]

Get a command line option's value; for options that may appear multiple times in the command line.

To enumerate all options, call this method with increasing index until you get back NULL.

Parameters:

	lpName	Name of the command line option/switch.
	dwRelIndex	Zero-based relative index of the requested command line option/switch. Relative means the index of the requested option in the subset of all options with the specified name.

Returns:

NULL, if the option is not present in the command line.

Non-NULL, the option's value, if the option is present in the command line. If no value is specified (command line switch), the string is empty.

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

virtual LPCTSTR IKpCommandLine::GetOption

(

LPCTSTR

lpName

)

[pure virtual]

Get a command line option's value.

Parameters:

lpName

Name of the command line option/switch.

Returns:

NULL, if the option is not present in the command line.

Non-NULL, the option's value, if the option is present in the command line. If no value is specified (command line switch), the string is empty.

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

virtual LPCTSTR IKpCommandLine::GetPassword

(

)

[pure virtual]

Get the password specified on the command line.

Returns:

The specified password.

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

virtual LPCTSTR IKpCommandLine::GetToken

(

DWORD

dwIndex

)

[pure virtual]

Get a command line token (option name and value).

To enumerate all tokens, call this method with increasing index until you get back NULL.

Parameters:

dwIndex

Index of the command line token to get.

Returns:

NULL, if the token is not present in the command line.

Non-NULL, the token, if the token is present in the command line.

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

virtual LPCTSTR IKpCommandLine::GetTokenRel	(	LPCTSTR	lpName,
		DWORD	dwRelIndex
	)			[pure virtual]

Get a command line token (option name and value); tokens are identified relatively by an index into the subset of tokens with the specified command line option name.

To enumerate all tokens, call this method with increasing index until you get back NULL.

Parameters:

	lpName	Name of the command line option/switch.
	dwRelIndex	Zero-based relative index of the requested command line token. Relative means the index of the requested token in the subset of all token with the specified option name.

Returns:

NULL, if the token is not present in the command line.

Non-NULL, the token's value, if the token is present in the command line.

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

virtual BOOL IKpCommandLine::IsPreselectEnabled

(

)

[pure virtual]

Returns whether the '-preselect' option is present in the command line or not.

virtual BOOL IKpCommandLine::IsReadOnlyEnabled

(

)

[pure virtual]

Returns whether the '-readonly' option is present in the command line or not.

---

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

• IKpCommandLine.h