HrTextFromCompressedRTFStreamEx

The HrTextFromCompressedRTFStreamEx function converts RTF-compressed text to ANSI text.

Quick Info

HRESULT HrTextFromCompressedRTFStreamEx(
  LPSTREAM pstmCompressed,  
  LPSTREAM FAR * ppstmText,  
  RTFSYNCINFO FAR * psi,  
  ULONG cpid,             
  ULONG cAttach,          
  ULONG FAR * rgAttachPos  
);
 

Parameters

pstmCompressed

Input parameter. Points to the compressed RTF stream.

ppstmText

Output parameter. Points to the address where the ANSI text is stored.

psi

Output parameter. Points to an RTFSYNCINFO structure containing the operations that must be done to synchronize the text.

cpid

Input parameter. The code page for the text stream. It can be any code page including UNICODE. If cpid is zero (0), HrTextFromCompressedRTFStreamEx uses the current system code page. If the requested code page is not supported, HrTextFromCompressedRTFStreamEx can return S_FALSE during a read or copy operation.

cAttach

Input parameter. The number of attachments in the array where rgAttachPos points.

rgAttachPos

Input/output parameter. An array containing the current rendering position for each attachment in the message. The number of elements in the array must match cAttach. The caller must fill in this array with the current attachment positions to guarantee proper handling of position 0xFFFFFFFF attachments. The values in rgAttachPos are updated while the stream is processed and are only accurate when the stream has been exhausted. Attachments with initial position 0xFFFFFFFF are not updated. If there are more attachments than RTF attachment tags, remaining attachments are updated to position 0xFFFFFFFF. If there are fewer attachments than RTF tags, the extra RTF tags are ignored.

Return Values

See Return Values.

Remarks

For information about the RTFSync function, see the MAPI Programmer's Reference.

See Also

HrRTFCompressedToText, HrTextToRTFCompressed, RTFSYNCINFO