
###################################
A3DGlobalGetGraphDottingPatternData
###################################

.. c:function:: A3DStatus A3DGlobalGetGraphDottingPatternData(const A3DUns32 uiIndexDottingPattern, A3DGraphDottingPatternData *pData)

   .. rst-class:: sig-pretty-signature
   
      | :c:enum:`~A3DStatus` A3DGlobalGetGraphDottingPatternData(*const* :c:type:`~A3DUns32` **uiIndexDottingPattern**\ , :c:struct:`~A3DGraphDottingPatternData`\ \* **pData**\ )
   
   Retrieves an ``A3DGraphDottingPatternData`` instance.
   
   
      2.0
   
   
   HOOPS stores pattern information in a global state using indexes. When given an index, call ``A3DGlobalGetGraphDottingPatternData`` to fill in an ``A3DGraphDottingPatternData`` instance.
   
   .. code-block:: c
   
      // Retrieves the picture data at index 3:
      A3DGraphDottingPatternData pattern_data = A3D_MAKE_DATA(A3DGraphDottingPatternData);
      A3DStatus result = A3DGlobalGetGraphDottingPatternData(3, &pattern_data);
      assert(result == A3D_SUCCESS);
   
   **Return Values**
   
   
      **A3D_SUCCESS**\ : in case of success.
   
      **A3D_INITIALIZE_NOT_CALLED**\ : if the library is not initialized
   
      **A3D_INVALID_PATTERN_INDEX**\ : if ``uiIndexDottingPattern`` does not match any existing.
   
      **A3D_BASEWITHGRAPHICS_BAD_ENTITY_TYPE**\ : if ``uiIndexDottingPattern`` is invalid but indexes an other pattern type (either ``A3DGraphHatchingPatternData``\ , ``A3DGraphSolidPatternData`` or ``A3DGraphVPicturePatternData``\ )
   
      **A3D_INVALID_DATA_STRUCT_NULL**\ : if ``pData`` is null.
   
      **A3D_INVALID_DATA_STRUCT_SIZE**\ : if ``pData`` is incorrectly initialized
   
   
   
      :c:struct:`~A3DGraphDottingPatternData`
   
   
   
      :c:func:`~A3DGlobalInsertGraphDottingPattern`
   
   
   
      :c:struct:`~A3DGraphHatchingPatternData`
   
   
   
      :c:struct:`~A3DGraphSolidPatternData`
   
   
   
      :c:struct:`~A3DGraphVPicturePatternData`
   
   
   **Parameters**
   
   
      **uiIndexDottingPattern**\ : The index of the pattern.
   
      **pData**\ : The ``A3DGraphDottingPatternData`` to fill in.
   
   
   **Returns**
   
   
      ``A3D_SUCCESS`` or an error code in case of failure.
   
   




