EmEditor Home - EmEditor Help - Plug-in Reference - Messages

EE_CLIP_HISTORY

Manipulates the Clipboard history. You can send this message explicitly or by using the Editor_GetClip, Editor_GetClipPos, Editor_InsertClip, Editor_RemoveClip, Editor_RotateClip, or Editor_SetClipPos inline function.

EE_CLIP_HISTORY
    wParam = 0;
    lParam = (LPARAM) (CLIP_INFO) pCI;

Parameters

pTI

Pointer to the CLIP_INFO structure.

Return Values

If the message fails, the return value is -1. If the message succeeds, the return value depends on the value specified as the nAction parameter of the CLIP_INFO structure. If the nAction parameter is CI_GET_CLIP, the return value is the size of the pszBuf buffer in characters needed to receive the text including the terminating NULL. If the nAction parameter is CI_INSERT_CLIP, the return value is the position in the Clipboard history where the new text is inserted. If the nAction parameter is CI_REMOVE_CLIP, the return value is the position in the Clipboard history where the text is removed. If the nAction parameter is CI_GET_CLIP_POS, the return value is the current position in the Clipboard history. If the nAction parameter is CI_SET_CLIP_POS, the return value is the old position in the Clipboard history. If the nAction parameter is CI_ROTATE_CLIP, the return value is 1.

Version

Supported on EmEditor Version 9.00 or later.

Copyright 2003-2015 by Emurasoft, Inc.