IKpFullPathName Struct Reference

Interface to an object wrapping a path. More...

#include <IKpFullPathName.h>

Inheritance diagram for IKpFullPathName:

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 DWORD	GetState ()=0
	Get the state of this object.
virtual LPCTSTR	GetFullPathName ()=0
	Get the full path and file name.
virtual LPCTSTR	GetPathOnly ()=0
	Get only the path.
virtual LPCTSTR	GetFileName ()=0
	Get only the file name.

---

Detailed Description

Interface to an object wrapping a path.

Use IKpAPI::CreateInstanceEx to create an object providing this interface; use CLSID_KpFullPathName as CLSID, 0 as lParamW, and a path string pointer as lParamL.

---

Member Function Documentation

virtual ULONG IKpFullPathName::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 IKpFullPathName::GetFileName

(

)

[pure virtual]

Get only the file name.

Returns:

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

virtual LPCTSTR IKpFullPathName::GetFullPathName

(

)

[pure virtual]

Get the full path and file name.

Returns:

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

virtual LPCTSTR IKpFullPathName::GetPathOnly

(

)

[pure virtual]

Get only the path.

Returns:

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

virtual DWORD IKpFullPathName::GetState

(

)

[pure virtual]

Get the state of this object.

Returns:

Possible return values are:

• KPFPN_UNINITIALIZED. The object has not been initialized yet.
• KPFPN_INVALID_PATH. The wrapped path is invalid.
• KPFPN_PATH_ONLY. The wrapped path ends in "\".
• KPFPN_PATH_AND_FILENAME. The wrapped path does not end in "\"; last part is filename.

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

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

Implements IKpUnknown.

virtual ULONG IKpFullPathName::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:

• IKpFullPathName.h