Show/Hide Toolbars

EmEditor Help

Navigation: EmEditor Help > Plug-in Reference > Structures

EmEditor Plug-in Reference: COLUMN_STRUCT

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

COLUMN_STRUCT

Used by Editor_GetColumn inline function (EE_GET_COLUMN message) or Editor_SetColumn inline function (EE_SET_COLUMN message).

typedef struct _COLUMN_STRUCT {

   UINT cbSize;

   int iColumn;

   UINT_PTR yLineTop;

   UINT_PTR yLines;

   LPWSTR pBuf

   UINT_PTR cchBuf;

   LPCWSTR pszDelimiter;

   UINT flags;

   HGLOBAL hGlobalData;

} COLUMN_STRUCT;

Fields

cbSize

Specifies the size of this structure in bytes, sizeof(COLUMN_STRUCT).

iColumn

Specifies the index of the column.

yLineTop

Specifies a line number of the first line to set.

yLines

Specifies the number of lines to set as a limit. If this is zero, no limit is specified.

pBuf

Specifies a string to set or insert when used with the Editor_SetColumn inline function (EE_SET_COLUMN message). The string can be separated by the delimiter specified in strDelimiter. It also specifies a buffer to receive the string when used with the Editor_GetColumn inline function (EE_GET_COLUMN message).

cchBuf

Specifies the size of the buffer in characters when used with Editor_GetColumn inline function (EE_GET_COLUMN message).

pszDelimiter

Specifes the delimiter to separate the string specified in pBuf. If this is empty, the same string is used for every cell in the column.

flags

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

Don't do the above process.

ALWAYS_QUOTE

Always add quotes.

USE_HGLOBAL

Specifies that the hGlobalData should be filled with the newly allocated global memory when used with the Editor_GetColumn inline function (EE_GET_COLUMN message). The pBuf and cchBuf fields must be 0 when this flag is used.

hGlobalData

Specifes a variable that receives a handle to the newly allocated global memory object when used with the Editor_GetColumn inline function (EE_GET_COLUMN message). The caller must free this memory object using the GlobalFree function.

Copyright © 2003-2021 by Emurasoft, Inc.