Show/Hide Toolbars

EmEditor Help

Navigation: EmEditor Help > Plug-in Reference > Structures

EmEditor Plug-in Reference: JOIN_INFO

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

JOIN_INFO

Used by EE_JOIN message.

typedef struct _JOIN_INFO {

   UINT cbSize;

   UINT flags;

   LPCWSTR pszDocument1;

   LPCWSTR pszDocument2;

   LPCWSTR pszColumn1;

   LPCWSTR pszColumn2;

   LPCWSTR pszSelect;

   UINT iDocument3;

} JOIN_INFO;

Fields

cbSize

Specifies the size of this structure, sizeof( JOIN_INFO ).

flags

Specifies a combination of the following values.

JOIN_FLAG_UNIQUE_KEY_1

The specified column in the first document contains a unique key.

JOIN_FLAG_UNIQUE_KEY_2

The specified column in the second document contains a unique key.

JOIN_FLAG_INCLUDE_ALL_1

All lines in the first document should be included in the output. The output document will contain empty cells if lines in the first document do not have matches.

JOIN_FLAG_INCLUDE_ALL_2

All lines in the second document should be included in the output. The output document will contain empty cells if lines in the second document do not have matches.

JOIN_FLAG_MATCH_CASE

Matches cases.

pszDocument1

Specifies the string to identify the first document. This value can be a file name, file name with the full path, or a colon (:) followed by the index of the document in the current group. For example, "filename.csv", "C:\data\filename.csv", or ":2".

pszDocument2

Specifies the string to identify the second document. The format of this value is the same as pszDocument1.

pszColumn1

Specifies the string to identify the key column of the first document. This value can be either the first line of the column or a colon (:) followed by the index of the colulmn. For example, "first_name" or ":5".

pszColumn2

Specifies the string to identify the key column of the second document. The format of this value is the same as pszColumn1.

pszSelect

Specifies the string to select which columns to include in the output document. For example, "file1.csv>column1,file2.csv>column2".

iDocument3

This field will be filled with the index of the output document when the function returns.

Version

Supported on EmEditor Professional Version 14.8 or later.

Copyright © 2003-2016 by Emurasoft, Inc.