
###########################
A3DRWParamsMultiEntriesData
###########################

.. c:struct:: A3DRWParamsMultiEntriesData

   Defines which configurations or sub-models should be loaded when the CAD file has multiple entries.
   
   Some CAD formats may create CAD files with multiple entries. For these files, the :c:struct:`~A3DRWParamsMultiEntriesData`\ structure must be used to specify to the load function which entry should be loaded. The entry can be specified by its name, or it can be the default entry if the CAD file contains one.
   
   The :c:struct:`~A3DRWParamsMultiEntriesData`\ structure is implemented for following CAD formats:
   
   
   - Multiple entries are for sub-models.
   - CATIA V4 files never contain default entries.
   - :c:member:`m_bLoadDefault <A3DRWParamsMultiEntriesData.m_bLoadDefault>`\ is not implemented.
   - :c:member:`m_ppcEntries <A3DRWParamsMultiEntriesData.m_ppcEntries>`\ should contain a single name, the name of the root product occurrence to load.
   - The load function loads the selected entry, other entries are not loaded, in any way.
   - Entries names can be retrieved from a first call to the load function, and a parsing of the returned model file and the product occurrences structure. Here, note that only the root product occurrences should be parsed.
   
   
   - Multiple entries are for configurations.
   - SolidWorks files always contain a default entry.
   - :c:member:`m_bLoadDefault <A3DRWParamsMultiEntriesData.m_bLoadDefault>`\ is implemented.
   - :c:member:`m_ppcEntries <A3DRWParamsMultiEntriesData.m_ppcEntries>`\ should contain a single name, the name of the configuration to load.
   - The load function loads the selected entry, other entries are loaded in a 'structure only' mode (only the Product Occurrences structure is loaded, not the geometric content; all these Product Occurrences have a status which is not Loaded).
   - Entries names can be retrieved from a first call to the load function, and a parsing of the returned model file and the product occurrences structure. Here, note that only the product occurrences of type 'Configuration', sons of the root 'Container' product should be parsed (see :c:member:`A3DAsmProductOccurrenceData::m_uiProductFlags <A3DAsmProductOccurrenceData.m_uiProductFlags>`\ and :ref:`Bit field flag definitions for product occurrences <group__a3d__product__flag>`\ ).
   
   The load function behaves as follows:
   
   
   - If no MultiEntries parameter is specified and the file contains multiple entries, the load function loads the product structure only, and returns an error :c:enumerator:`~A3D_LOAD_MULTI_MODELS_CADFILE`\ . The user can use the returned model file to get the Entry names which will be useful to a second call of the load function with the selected entry.
   - If no MultiEntries parameter is specified and the file contains only one entry, the load function automatically loads the model.
   - If the file contains a default entry and :c:member:`m_bLoadDefault <A3DRWParamsMultiEntriesData.m_bLoadDefault>`\ is ``A3D_TRUE``\ , the load function automatically loads the default entry.
   - if :c:member:`m_ppcEntries <A3DRWParamsMultiEntriesData.m_ppcEntries>`\ defines an entry as described above and the file contains multiple entries, the selected entry is loaded.
   
   
   Index
   =====
   
   .. rubric:: Variables
   
   
   .. rst-class:: api-xref-list
   
   
   * :c:member:`~A3DRWParamsMultiEntriesData.m_bLoadDefault`
   * :c:member:`~A3DRWParamsMultiEntriesData.m_uiEntriesSize`
   * :c:member:`~A3DRWParamsMultiEntriesData.m_ppcEntries`
   
   



.. rst-class:: kind-group kind-variable

.. rubric:: Variables
   :class: kind-group-title


.. c:member:: A3DBool A3DRWParamsMultiEntriesData.m_bLoadDefault

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DBool`
      
      A value of ``A3D_TRUE``\ is to load the default entry on a multi-entry file. Nothing changes for non multi-entry files.
      



.. c:member:: A3DUns32 A3DRWParamsMultiEntriesData.m_uiEntriesSize

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DUns32`
      
      The size of :c:member:`m_ppcEntries <A3DRWParamsMultiEntriesData.m_ppcEntries>`\ .
      



.. c:member:: A3DUTF8Char** A3DRWParamsMultiEntriesData.m_ppcEntries

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DUTF8Char`\ \*\*
      
      Strings defining the entry to load in case of a multi-entry file. See description paragraph above.
      




