ICapabilities Struct Reference

#include <Capability.h>

Inherited by CitrixMobile.

List of all members.

Public Member Functions
STDMETHODIMP	GetCapabilityBool ([in]CMP_CAP_ID capId,[in]CMP_KEY_ID keyId,[out]VARIANT_BOOL *keyValue,[out, retval]CMPRESULT *result)
	Get capability boolean value.
STDMETHODIMP	GetCapabilityInt16 ([in]CMP_CAP_ID capId,[in]CMP_KEY_ID keyId,[out]INT16 *keyValue,[out, retval]CMPRESULT *result)
	Get capability integer 16-bit value.
STDMETHODIMP	GetCapabilityUInt16 ([in]CMP_CAP_ID capId,[in]CMP_KEY_ID keyId,[out]UINT16 *keyValue,[out, retval]CMPRESULT *result)
	Get capability unsigned integer 16-bit value.
STDMETHODIMP	GetCapabilityInt32 ([in]CMP_CAP_ID capId,[in]CMP_KEY_ID keyId,[out]INT32 *keyValue,[out, retval]CMPRESULT *result)
	Get capability integer 32-bit value.
STDMETHODIMP	GetCapabilityUInt32 ([in]CMP_CAP_ID capId,[in]CMP_KEY_ID keyId,[out]UINT32 *keyValue,[out, retval]CMPRESULT *result)
	Get capability unsigned integer 32-bit value.

---

Member Function Documentation

STDMETHODIMP ICapabilities::GetCapabilityBool	(	[in] CMP_CAP_ID	capId,
		[in] CMP_KEY_ID	keyId,
		[out] VARIANT_BOOL *	keyValue,
		[out,retval] CMPRESULT *	result
	)

Get capability boolean value.

Return capability setting to the caller. This call only returns VARIANT_BOOL which is a short. The reason for using this instead of BOOL is that VARIANT_BOOL is compatible with automation. The capability id along with the key id determines which setting we are trying to get. Internally in the MRVC User mode code, it maps the request to the actual capability data. This API strategy is easier than having to implement one call per capability setting.

Parameters:

capId	- capability selected (e.g. CAPID_INPUT) CMP_CAP_ID
keyId	- key selected (e.g. CAP_INPUT_ENABLE)
keyValue	- returned value (boolean)
result	- CMP-based result

Returns:

HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICapabilities::GetCapabilityInt16	(	[in] CMP_CAP_ID	capId,
		[in] CMP_KEY_ID	keyId,
		[out] INT16 *	keyValue,
		[out,retval] CMPRESULT *	result
	)

Get capability integer 16-bit value.

Return capability setting to the caller. This call only returns INT16. This call is compatible with automation. The capability id along with the key id determines which setting we are trying to get. Internally in the MRVC User mode code, it maps the request to the actual capability data. This API strategy is easier than having to implement one call per capability setting.

Parameters:

capId	- capability selected (e.g. CAPID_INPUT) CMP_CAP_ID
keyId	- key selected (e.g. CAP_INPUT_ENABLE)
keyValue	- returned value (INT16)
result	- returned CMP-based result

Returns:

HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICapabilities::GetCapabilityInt32	(	[in] CMP_CAP_ID	capId,
		[in] CMP_KEY_ID	keyId,
		[out] INT32 *	keyValue,
		[out,retval] CMPRESULT *	result
	)

Get capability integer 32-bit value.

Return capability setting to the caller. This call only returns INT32. This call is compatible with automation. The capability id along with the key id determines which setting we are trying to get. Internally in the MRVC User mode code, it maps the request to the actual capability data. This API strategy is easier than having to implement one call per capability setting.

Parameters:

capId	- capability selected (e.g. CAPID_INPUT) CMP_CAP_ID
keyId	- key selected (e.g. CAP_INPUT_ENABLE)
keyValue	- returned value (INT32)
result	- returned CMP-based result

Returns:

HRESULT

STDMETHODIMP ICapabilities::GetCapabilityUInt16	(	[in] CMP_CAP_ID	capId,
		[in] CMP_KEY_ID	keyId,
		[out] UINT16 *	keyValue,
		[out,retval] CMPRESULT *	result
	)

Get capability unsigned integer 16-bit value.

Return capability setting to the caller. This call only returns UINT16. This call is not compatible with automation. The capability id along with the key id determines which setting we are trying to get. Internally in the MRVC User mode code, it maps the request to the actual capability data. This API strategy is easier than having to implement one call per capability setting.

Parameters:

capId	- capability selected (e.g. CAPID_INPUT) CMP_CAP_ID
keyId	- key selected (e.g. CAP_INPUT_ENABLE)
keyValue	- returned value (UINT16)
result	- CMP-based result

Returns:

HRESULT

STDMETHODIMP ICapabilities::GetCapabilityUInt32	(	[in] CMP_CAP_ID	capId,
		[in] CMP_KEY_ID	keyId,
		[out] UINT32 *	keyValue,
		[out,retval] CMPRESULT *	result
	)

Get capability unsigned integer 32-bit value.

Return capability setting to the caller. This call only returns UINT32. This call is not compatible with automation. The capability id along with the key id determines which setting we are trying to get. Internally in the MRVC User mode code, it maps the request to the actual capability data. This API strategy is easier than having to implement one call per capability setting.

Parameters:

capId	- capability selected (e.g. CAPID_INPUT) CMP_CAP_ID
keyId	- key selected (e.g. CAP_INPUT_ENABLE)
keyValue	- returned value (UINT32)
result	- CMP-based result

Returns:

HRESULT

---

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

• Capability.h
• cmpcom_en.txt