MKI_PARTSLIST_DATA (Basic Classes) Changed in Version 2022.2

C++ Syntax

class MKI_PARTSLIST_DATA

{

  public:

  MKI_LIBRARYNAME m_szLibraryName;

  MKI_FILENAMEW   m_szFileName;

  MKI_STR32W      m_szNAText,

                  m_szNANumber;

  __int32 m_nFileType,

          m_nUseMode,

          m_nParseMode,

          m_nArrangeMode,

          m_nRanges,

          m_nTextDelimiter,

          m_nRecordSeparator,

          m_nFieldSeparator;

  bool m_fHeadline;

  MKI_PARTSLIST_ATTRIB m_acSelection[MKI_PARTSLIST_ARRANGE_TOTAL];

  MKI_PARTSLIST_DATA( void );

  void

  Init( void );

};

This structure contains settings for a parts list creation.

Element Description

LibraryName

[MKI_LIBRARYNAME] Library name used if UseMode is MKI_PARTSLIST_USE_LIBRARY.

FileName

[MKI_FILENAMEW] Output file name (for file creation) or database name (for database creation).

NAText

[MKI_STR32W] Replacement text used for any text field that does not have any content.

NANumber

[MKI_STR32W] Replacement text used for any number field that does not have any content (should contain a valid number).

FileType

[__int32] File encoding type to be used. Possible values are:

MKI_PARTSLIST_FILE_ANSI

The file shall be ANSI encoded.

MKI_PARTSLIST_FILE_UTF8

The file shall be UTF-8 encoded.

UseMode

[__int32] Determines which instances / position numbers of the drawing shall be used. Possible values are:

MKI_PARTSLIST_USE_ALL

Use all objects.

MKI_PARTSLIST_USE_SELECTION

Use only permanently selected objects.

MKI_PARTSLIST_USE_LIBRARY

Use only instances of blocks from the library stated in LibraryName. Not usable when enumerating position numbers.

ParseMode

[__int32] Determines how to parse nested instances. Possible values are:

MKI_PARTSLIST_PARSE_TOP_ONLY

Enumerate the topmost instances only.

MKI_PARTSLIST_PARSE_ALL_LEVELS

Enumerate instances on all levels.

MKI_PARTSLIST_PARSE_BOTTOM_ONLY

Enumerate the bottommost instances only.

ArrangeMode Renamed in Version 2022.2

[__int32] Determines what type of data shall be enumerated and how it shall be grouped. Possible values are:

MKI_PARTSLIST_ARRANGE_ALL_SINGLE New in Version 2022.2

Enumerate all top-level objects, groups, instances, and such according to ParseMode. Each object will be listed separately. Local attributes can be used.

MKI_PARTSLIST_ARRANGE_INST_SINGLE Renamed in Version 2022.2

Enumerate all top-level instances. Each instance will be listed separately. Local attributes can be used. ParseMode will be ignored.

MKI_PARTSLIST_ARRANGE_INST_GROUPED Renamed in Version 2022.2

Enumerate all instances according to ParseMode. Multiple instances of the same block will be combined.

MKI_PARTSLIST_ARRANGE_POSNO_SINGLE Renamed in Version 2022.2

Enumerate all top-level position numbers of the ranges active in Ranges. Each position number will be listed individually. ParseMode will be ignored.

MKI_PARTSLIST_ARRANGE_POSNO_GROUPED Renamed in Version 2022.2

Enumerate all top-level position numbers of the ranges active in Ranges. Multiple position numbers of the same range and with the same value will be combined. ParseMode will be ignored.

Ranges

[__int32] Bit-wise OR combination of bits for all of the 10 available position number ranges to be used (0x00000001 for basic range, 0x00000002 for range 1, 0x00000004 for range 2, 0x00000008 for range 3, etc.).

TextDelimiter

[__int32] Determines how text fields are delimited (see MKI_DELIMITER_*).

RecordSeparator

[__int32] Determines how records (lines) are separated (see MKI_SEPARATOR_*).

FieldSeparator

[__int32] Determines how fields (columns) are separated (see MKI_SEPARATOR_*).

Headline

[bool] If true, the attributes' names will be written to the first line of the parts list as a headline.

Selection

[MKI_PARTSLIST_ATTRIB[]] Separate lists of selected attributes for each GroupMode.