Windows Dev Center

Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ITfContext::GetAppProperty method

Syntax


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

Parameters

guidProp [in]

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

ppProp [out]

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

Return value

This method can return one of these values.

ValueDescription
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

Minimum supported client

Windows 2000 Professional [desktop apps | Windows Store apps]

Minimum supported server

Windows 2000 Server [desktop apps | Windows Store apps]

Redistributable

TSF 1.0 on Windows 2000 Professional

Header

Msctf.h

IDL

Msctf.idl

DLL

Msctf.dll

See also

ITfContext
Predefined Properties
ITfReadOnlyProperty
ITfContext::GetProperty

 

 

Community Additions

Show:
© 2015 Microsoft