CMFCFilterChunkValueImpl::SetTextValue

  • Article

Sets the property by key to a Unicode string.

HRESULT SetTextValue(
   REFPROPERTYKEY pkey,
   LPCTSTR pszValue,
   CHUNKSTATE chunkType = CHUNK_VALUE,
   LCID locale = 0,
   DWORD cwcLenSource = 0,
   DWORD cwcStartSource = 0,
   CHUNK_BREAKTYPE chunkBreakType = CHUNK_NO_BREAK
);

Parameters

  • pkey
    Specifies a property key.

  • pszValue
    Specifies the chunk value to set.

  • chunkType
    Flags indicate whether this chunk contains a text-type or a value-type property. Flag values are taken from the CHUNKSTATE enumeration.

  • locale
    The language and sublanguage associated with a chunk of text. Chunk locale is used by document indexers to perform proper word breaking of text. If the chunk is neither text-type nor a value-type with data type VT_LPWSTR, VT_LPSTR, or VT_BSTR, this field is ignored.

  • cwcLenSource
    The length in characters of the source text from which the current chunk was derived. A zero value signifies character-by-character correspondence between the source text and the derived text. A nonzero value means that no such direct correspondence exists.

  • cwcStartSource
    The offset from which the source text for a derived chunk starts in the source chunk.

  • chunkBreakType
    The type of break that separates the previous chunk from the current chunk. Values are from the CHUNK_BREAKTYPE enumeration.

Return Value

S_OK if successful; otherwise an error code.

Requirements

Header: afxwin.h

See Also

Reference

CMFCFilterChunkValueImpl Class