EmEditor Home - EmEditor Help - Plug-in Reference - Inline Functions

Editor_GetClip

Retrieves text at the specified position in the Clipboard history. You can use this inline function or explicitly send the EE_CLIP_HISTORY message.

Editor_GetClip( HWND hwnd, LPWSTR pszBuf, UINT cchBuf, UINT iPos, UINT* pnFlags );

Parameters

hwnd

Specifies the window handle of the view or frame of EmEditor.

pszBuf

Specifies the buffer that receives the text

cchBuf

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

iPos

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

nFlags

This value is filled with the actual Clipboard format.

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.

Return Values

The return value is the size of the pszBuf buffer in characters needed to receive the text including the terminating NULL. If the message fails, the return value is -1.

Version

Supported on EmEditor Version 9.00 or later.

Copyright 2003-2015 by Emurasoft, Inc.