EmEditor Home - EmEditor Help - Plug-in Reference - Structures

CLIP_INFO

Used by EE_CLIP_HISTORY message.

typedef struct _CLIP_INFO {
    size_t cbSize;
    LPWSTR pszBuf;
    UINT cchBuf;
    UINT iPos;
    UINT nAction;
    UINT nFlags;
} CLIP_INFO;

Members

cbSize

Size of this data structure, in bytes. Set this member to sizeof( CLIP_INFO ) before sending the EE_CLIP_HISTORY message.

pszBuf

Specifies the buffer that receives the text, or the text to be inserted.

cchBuf

Specifies the size of the buffer in characters including the terminating NULL character.

iPos

Specifies a position in the Clipboard history. If (UINT)-1 is specified while nAction specifies CI_GET_CLIP, the actual clipboard contents are retrieved rather than getting from the Clipboard history.

nAction

Specifies one of the following values. However, only CI_INSERT_CLIP can be combined with CI_FLAG_NO_UPDATE_REAL_CLIP.

CI_GET_CLIP Retrieves text at the specified position in the Clipboard history.
CI_INSERT_CLIP Inserts text at the specified position in the Clipboard history.
CI_REMOVE_CLIP Removes text at the specified position in the Clipboard history.
CI_GET_POS Retrieves the current position in the Clipboard history.
CI_SET_POS Sets the current position in the Clipboard history.
CI_ROTATE_CLIP Rotates the current position in the Clipboard history.
CI_FLAG_NO_UPDATE_REAL_CLIP Prevents the current real Clipboard contents replaced by the Clipboard History. This value can be used in combination with CI_INSERT_CLIP.

nFlags

When nAction is CI_INSERT_CLIP or CI_REMOVE_CLIP, this value specifies the format of the Clipboard to be inserted or removed. When nAction is CI_GET_CLIP, this value is filled with the actual Clipboard format. Otherwise this value is ignored, and it must be zero. If this value is needed, it is one of the following values

SEL_TYPE_CHAR The Clipboard format is normal text.
SEL_TYPE_LINE The Clipboard format is lines of text.
SEL_TYPE_BOX The Clipboard format is vertical selection of text.

Version

Supported on Version 9.00 or later.

Copyright 2003-2014 by Emurasoft, Inc.