IXpsOMCoreProperties::GetKeywords method
Gets the keywords property.
Syntax
HRESULT GetKeywords(
[out, retval] LPWSTR *keywords
);
Parameters
- keywords [out, retval]
The string that is read from the keywords property.
Return value
The method returns an HRESULT. Possible values include, but are not limited to, those in the table that follows. For information about XPS document API return values that are not listed in this table, see XPS Document Errors.
| Return code | Description |
|---|---|
| S_OK | The method succeeded. |
| E_POINTER | keywords is NULL. |
Remarks
The keywords property is a delimited set of keywords that are used to support searching and indexing. This is typically a list of terms that are not available in other properties.
This method allocates the memory used by the string that is returned in keywords. If keywords is not NULL, use the CoTaskMemFree function to free the memory.
Requirements
Minimum supported client |
Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps | Windows Store apps] |
Minimum supported server |
Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps | Windows Store apps] |
Header |
Xpsobjectmodel.h |
IDL |
XpsObjectModel.idl |