.. _group__a3d__read:

###########
Load Module
###########

Loads the model file with information from the input CAD file. 

**Parameters**


   **pcFileName**\ : The system path to the input file. Must be a valid UTF-8 string. 

   **pLoadParametersData**\ : A set of options used to customize the behaviour of the loading. 

   **ppModelFile**\ : A pointer to the handle of the new model file, in case of success. 


**Returns**


   ``A3D_SUCCESS`` or an error code in case of failure.



Index
=====

.. rubric:: Variables


.. rst-class:: api-xref-list


* :c:member:`~param`


.. rst-class:: kind-group kind-record

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


.. rst-class:: api-xref-list


* :c:struct:`~A3DRWParamsGeneralData`
* :c:struct:`~A3DRWParamsPmiData`
* :c:struct:`~A3DRWParamsTessellationData`
* :c:struct:`~A3DRWParamsSearchDirData`
* :c:struct:`~A3DRWParamsAssemblyData`
* :c:struct:`~A3DRWParamsMultiEntriesData`
* :c:struct:`~A3DRWParamsCatiaV4Data`
* :c:struct:`~A3DRWParamsCatiaV5Data`
* :c:struct:`~A3DRWParamsNXData`
* :c:struct:`~A3DRWParamsCreoData`
* :c:struct:`~A3DRWValidationPropertiesThresholdData`
* :c:struct:`~A3DRWParamsStepData`
* :c:struct:`~A3DRWParamsIGESData`
* :c:struct:`~A3DRWParamsIFCData`
* :c:struct:`~A3DRWParamsJTData`
* :c:struct:`~A3DRWParamsParasolidData`
* :c:struct:`~A3DRWParamsSolidworksData`
* :c:struct:`~A3DRWParamsInventorData`
* :c:struct:`~A3DRWParamsRhinoData`
* :c:struct:`~A3DRWParamsRevitData`
* :c:struct:`~A3DRWParamsSolidEdgeData`
* :c:struct:`~A3DRWParamsSpecificLoadData`
* :c:struct:`~A3DRWParamsIncrementalLoadData`
* :c:struct:`~A3DRWParamsLoadData`
* :c:struct:`~A3DStream3DPDFData`
* :c:struct:`~A3DThumbnailData`
* :c:struct:`~A3DFileInformationData`
* :c:struct:`~A3DFileContextData`

.. rst-class:: kind-group kind-enumeration

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


.. rst-class:: api-xref-list


* :c:enum:`~A3DEReadGeomTessMode`
* :c:enum:`~A3DEUnits`
* :c:enum:`~A3DETessellationLevelOfDetail`
* :c:enum:`~A3DECreoSessionColorType`
* :c:enum:`~A3DECreoReadConstructEntities`
* :c:enum:`~A3DECreoFamilyTables`
* :c:enum:`~A3DEStepNameFromNAUO`
* :c:enum:`~A3DEJTReadTessellationLevelOfDetail`
* :c:enum:`~A3DERevitPhysicalProperties`
* :c:enum:`~A3DERevitLinks`
* :c:enum:`~A3DERevitMultiThreadedMode`
* :c:enum:`~A3DERevitLevelOfDetail`

.. rst-class:: kind-group kind-function

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


.. rst-class:: api-xref-list


* :c:func:`~A3DPDFGetStreams`
* :c:func:`~A3DGetFileFormat`
* :c:func:`~A3DCheckFileFormat`
* :c:func:`~A3DExtractFileThumbnail`
* :c:func:`~A3DGetFileInformation`
* :c:func:`~A3DAsmComputeFilePathsFromModelFile`
* :c:func:`~A3DAsmGetFilesContextsFromModelFile`
* :c:func:`~A3DPkPartsTranslateToA3DAsmModelFile`
* :c:func:`~A3DAsmModelFileLoadFromXMLFile`
* :c:func:`~A3DAsmModelFileLoadFromXMLStream`

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

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


.. c:member:: A3DStatus A3DGet3DPDFStreams param

      .. rst-class:: sig-pretty-signature
      
         | :c:enum:`~A3DStatus`
      
      Loads an ``A3DAsmModelFile`` from a physical file, returning a handle to the new model file. 
      
      Writes a model file to a physical file in GLTF/GLB format.
      
      Writes a model file to a physical file in FBX format.
      
      Writes a model file to a physical file in OBJ format (with MTL for the materials).
      
      Writes a model file to a physical file in XML format.
      
      Writes a model file to a physical file in 3MF format.
      
      Writes a model file to a physical file in STL format.
      
      Writes a model file to a physical file in IGES format.
      
      Writes a model file to a physical file in VRML format.
      
      Writes a model file to a physical file in JT format.
      
      Writes a model file to a physical file in STEP format.
      
      Writes a model file to a physical file in Universal 3D format.
      
      Free PRC write helper.
      
      Writes a model file to a physical file in a PRC format.
      
      Function to retrieve all 3D streams embedded in a PDF document.
      
      Loads an :c:type:`~A3DAsmModelFile` from a PRC physical file.
      
      Free PRC read helper.
      
      Loads an :c:type:`~A3DAsmModelFile` from a PRC Buffer.
      
      Successfully calling this function will always create a new model file, even if the call is made several times with the same input path. Once loaded, a handle to the new model file is stored in ``ppModelFile`` and you can query its content with ``A3DAsmModelFileGet``\ .
      
      
      ::
      
         A3DRWParamsLoadDataparameters;
         A3D_INITIALIZE_DATA(A3DRWParamsLoadData,parameters);
         A3DAsmModelFile*model_file=A3D_NULL_HANDLE;
         
         A3DStatusresult=A3DAsmModelFileLoadFromFile("/path/to/file.stl",&parameters,&model_file);
         
         assert(result==A3D_SUCCESS);
         assert(model_file!=0);
      
      **Parameters**
      
      
         **pcFileName**\ : The system path to the input file. Must be a valid UTF-8 string. 
      
         **pLoadParametersData**\ : A set of options used to customize the behaviour of the loading. 
      
         **ppModelFile**\ : A pointer to the handle of the new model file, in case of success. 
      
      
      **Returns**
      
      
         ``A3D_SUCCESS`` or an error code in case of failure.
      
      



.. toctree::
   :maxdepth: 1
   :hidden:

   ../structures/A3DRWParamsGeneralData
   ../structures/A3DRWParamsPmiData
   ../structures/A3DRWParamsTessellationData
   ../structures/A3DRWParamsSearchDirData
   ../structures/A3DRWParamsAssemblyData
   ../structures/A3DRWParamsMultiEntriesData
   ../structures/A3DRWParamsCatiaV4Data
   ../structures/A3DRWParamsCatiaV5Data
   ../structures/A3DRWParamsNXData
   ../structures/A3DRWParamsCreoData
   ../structures/A3DRWValidationPropertiesThresholdData
   ../structures/A3DRWParamsStepData
   ../structures/A3DRWParamsIGESData
   ../structures/A3DRWParamsIFCData
   ../structures/A3DRWParamsJTData
   ../structures/A3DRWParamsParasolidData
   ../structures/A3DRWParamsSolidworksData
   ../structures/A3DRWParamsInventorData
   ../structures/A3DRWParamsRhinoData
   ../structures/A3DRWParamsRevitData
   ../structures/A3DRWParamsSolidEdgeData
   ../structures/A3DRWParamsSpecificLoadData
   ../structures/A3DRWParamsIncrementalLoadData
   ../structures/A3DRWParamsLoadData
   ../structures/A3DStream3DPDFData
   ../structures/A3DThumbnailData
   ../structures/A3DFileInformationData
   ../structures/A3DFileContextData
   ../enums/A3DEReadGeomTessMode
   ../enums/A3DEUnits
   ../enums/A3DETessellationLevelOfDetail
   ../enums/A3DECreoSessionColorType
   ../enums/A3DECreoReadConstructEntities
   ../enums/A3DECreoFamilyTables
   ../enums/A3DEStepNameFromNAUO
   ../enums/A3DEJTReadTessellationLevelOfDetail
   ../enums/A3DERevitPhysicalProperties
   ../enums/A3DERevitLinks
   ../enums/A3DERevitMultiThreadedMode
   ../enums/A3DERevitLevelOfDetail
   ../functions/A3DPDFGetStreams
   ../functions/A3DGetFileFormat
   ../functions/A3DCheckFileFormat
   ../functions/A3DExtractFileThumbnail
   ../functions/A3DGetFileInformation
   ../functions/A3DAsmComputeFilePathsFromModelFile
   ../functions/A3DAsmGetFilesContextsFromModelFile
   ../functions/A3DPkPartsTranslateToA3DAsmModelFile
   ../functions/A3DAsmModelFileLoadFromXMLFile
   ../functions/A3DAsmModelFileLoadFromXMLStream


