SaveSegmentsToClipboard method

  • Article

Saves the segments contained in the segment list to the Clipboard.

Syntax

HRESULT retVal = object.SaveSegmentsToClipboard(pSegmentList, dwFlags);

Parameters

  • pSegmentList [in]
    Type: ISegmentList

    Pointer to an ISegmentList interface that specifies the list of segments to save to the Clipboard.

  • dwFlags [in]
    Type: DWORD

    DWORD that specifies an SAVE_SEGMENTS_FLAGS enumeration value to indicate save options.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

Segments are saved to the Clipboard in CF_HTML format, ASCII text, Unicode text, and Rich Text Format (RTF).

See also

HTML Clipboard Format