RTF_WCSINFO

  • Article

Applies to: Office 2010 | Outlook 2010 | Visual Studio

This structure enables you to specify information to decompress the body of a message in compressed Rich Text Format (RTF) and, optionally, return the body stream in its native format.

Quick Info

typedef struct { 
    ULONG size; 
    ULONG ulFlags; 
    ULONG ulInCodePage; 
    ULONG ulOutCodePage; 
} RTF_WCSINFO;

Members

  • size
    The size of the RTF_WCSINFO structure in number of bytes.

  • ulFlags
    This is the bitmask of option flags for the WrapCompressedRTFStreamEx function. The supported option flags are:

    MAPI_MODIFY

    This indicates whether the client intends to write the wrapped stream interface that is returned.

    STORE_UNCOMPRESSED_RTF

    This indicates whether the decompressed RTF is supposed to be written to the stream that is pointed to by the lpCompressedRTFStream pointer of the WrapCompressedRTFStreamEx function.

    MAPI_NATIVE_BODY

    This indicates whether the decompressed stream is also converted to the native body before returning the stream. This flag cannot be combined with the MAPI_MODIFY flag.

  • ulInCodePage
    This is the code page value of the message. Typically, this value is obtained from the PidTagInternetCodepage Canonical Property on the message. This value is only used when the MAPI_NATIVE_BODY flag is passed in ulFlags. Otherwise, this value is ignored.

  • ulOutCodePage
    This is the code page value of the returned decompressed stream that you want. If this is set to a non-zero value, the WrapCompressedRTFStreamEx function converts the stream to the specified code page. If this is set to a zero value, MAPI decides which code page to use. This value is used only when the MAPI_NATIVE_BODY flag is passed in ulFlags, and the body format is not RTF. Otherwise, this value is ignored.

See Also

Concepts

WrapCompressedRTFStreamEx