Show/Hide Toolbars

EmEditor Help

Navigation: EmEditor Help > Plug-in Reference > Structures

EmEditor Plug-in Reference: GET_CELL_INFO

Scroll Prev Top Next More
EmEditor Home - EmEditor Help - Plug-in Reference - Structures

GET_CELL_INFO

Used by Editor_GetCell and Editor_SetCell inline functions (EE_GET_CELL and EE_SET_CELL messages).

typedef struct _GET_CELL_INFO {

   UINT_PTR cch;

   UINT     flags;

   UINT_PTR yLine;

   int      iColumn;

} GET_CELL_INFO;

Fields

cch

If used with the Editor_GetCell inline funciton or EE_GET_CELL message, this field specifies the maximum number of characters to copy to the buffer (szString parameter of Editor_GetCell or lParam of EE_GET_CELL message including the NULL character). If zero is specified, the return value by Editor_GetCell macro or EE_GET_CELL message is the required size, in characters, for a buffer that can receive the text. However, if the iColumn field is -1, this value is ignored. This field is not used if used with the Editor_SetCell inline function or EE_SET_CELL message.

flags

If used with the Editor_GetCell inline funciton or EE_GET_CELL message, specifies on of the following values.

CELL_INCLUDE_NONE

The returned text may not include surrounded double-quotes or delimiters.

CELL_INCLUDE_QUOTES

The returned text may include surrounded double-quotes but no delimiters.

CELL_INCLUDE_QUOTES_AND_DELIMITER

The returned text may include surrounded double-quotes and delimiters.

If used with the Editor_SetCell inline funciton or EE_SET_CELL message, specifies on of the following values.

AUTO_QUOTE

Checks whether the string contains delimiters, newlines, or quotes, and escape those characters and add quotes if necessary.

DONT_QUOTE

Doesn't do the above process.

ALWAYS_QUOTE

Always adds quotes.

yLine

Specifies a line number of the text to retrieve or set.

iColumn

Specifies the index of the column of the text you want to retrieve or set.

Copyright © 2003-2017 by Emurasoft, Inc.