Edit

Share via

ITextStoreACP2::RequestSupportedAttrs method (textstor.h)

  • Article

Get the attributes that are supported in the document.

Syntax

HRESULT RequestSupportedAttrs(
  [in] DWORD           dwFlags,
  [in] ULONG           cFilterAttrs,
  [in] const TS_ATTRID *paFilterAttrs
);

Parameters

[in] dwFlags

Specifies whether a subsequent call to the RetrieveRequestedAttrs method will contain the supported attributes. If the TS_ATTR_FIND_WANT_VALUE flag is specified, the default attribute values will be those in the TS_ATTRVAL structure after the subsequent call to RetrieveRequestedAttrs. If any other flag is specified for this parameter, the method only verifies that the attribute is supported and that the varValue member of the TS_ATTRVAL structure is set to VT_EMPTY.

[in] cFilterAttrs

Specifies the number of supported attributes to obtain.

[in] paFilterAttrs

Pointer to the TS_ATTRID data type that specifies the attribute to verify. The method returns only the attributes specified by TS_ATTRID, even though other attributes can be supported.

Return value

This method can return one of these values.

Value Description
S_OK
 The method was successful.
E_FAIL
 An unspecified error occurred.
E_OUTOFMEMORY
 The method was unable to allocate sufficient memory to complete the operation.

Requirements

Requirement Value
Minimum supported client Windows 8 [desktop apps | UWP apps]
Minimum supported server Windows Server 2012 [desktop apps | UWP apps]
Target Platform Windows
Header textstor.h
DLL Msctf.dll

See also

ITextStoreACP2

TS_ATTRID

TS_ATTRVAL