ITfContext::GetAppProperty method (msctf.h)

Obtains an application property.

Syntax

HRESULT GetAppProperty(
  [in]  REFGUID             guidProp,
  [out] ITfReadOnlyProperty **ppProp
);

Parameters

[in] guidProp

Specifies the property identifier. This can be a custom identifier or one of the predefined property identifiers.

[out] ppProp

Pointer to an ITfReadOnlyProperty interface pointer that receives the property object.

Return value

This method can return one of these values.

Value	Description
S_OK	The method was successful.
S_FALSE	The context owner does not support the property.
TF_E_DISCONNECTED	The context is not on a document stack.
E_INVALIDARG	One or more parameters are invalid.
E_OUTOFMEMORY	A memory allocation failure occurred.
E_NOTIMPL	The context owner does not implement this method.
E_FAIL	An unspecified error occurred.

Remarks

Applications can define unique properties identified by a GUID. Properties are stored as VARIANT data, so the caller must recognize the format and meaning of unique properties to be able to use them.

Application properties differ from text properties, obtained by ITfContext::GetProperty, in that, application properties are maintained by the context owner and cannot be modified by a text service. Application properties can only be modified by the context owner.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps | UWP apps]
Minimum supported server	Windows 2000 Server [desktop apps | UWP apps]
Target Platform	Windows
Header	msctf.h
DLL	Msctf.dll
Redistributable	TSF 1.0 on Windows 2000 Professional

See also

ITfContext interface, ITfContext::GetProperty, ITfReadOnlyProperty interface, Predefined Properties