
################################
A3DGlobalGetGraphLinePatternData
################################

.. c:function:: A3DStatus A3DGlobalGetGraphLinePatternData(const A3DUns32 uiIndexLinePattern, A3DGraphLinePatternData *pData)

   .. rst-class:: sig-pretty-signature
   
      | :c:enum:`~A3DStatus` A3DGlobalGetGraphLinePatternData(*const* :c:type:`~A3DUns32` **uiIndexLinePattern**\ , :c:struct:`~A3DGraphLinePatternData`\ \* **pData**\ )
   
   Retrieves a line pattern descriptor.
   
   
      2.0
   
   
   HOOPS stores line patterns in a global state using indexes. When given an index, you may call ``A3DGlobalGetGraphLinePatternData`` to fill in an ``A3DGraphLinePatternData`` instance.
   
   .. code-block:: c
   
      // Retrieves the line pattern descriptor at index 3.
      A3DGlobalGetGraphLinePatternData descriptor;
      A3D_INITALIZE_DATA(A3DGlobalGetGraphLinePatternData, descriptor);
      A3DGlobalGetGraphLinePatternData(3, &descriptor);
      // Frees it:
      A3DGlobalGetGraphLinePatternData(A3D_DEFAULT_LINEPATTERN_INDEX, &descriptor);
   
   **Return Values**
   
   
      **A3D_SUCCESS**\ : in case of success.
   
      **A3D_INITIALIZE_NOT_CALLED**\ : if the library is not initialized
   
      **A3D_INVALID_DATA_STRUCT_NULL**\ : if ``pData`` is null.
   
      **A3D_INVALID_DATA_STRUCT_SIZE**\ : if ``pData`` is incorrectly initialized
   
      **A3D_INVALID_LINEPATTERN_INDEX**\ : if the given index is negative or corresponds to a non-existing line pattern.
   
   
   
      :c:struct:`~A3DGraphLinePatternData`
   
   
   
      :c:func:`~A3DGlobalInsertGraphLinePattern`
   
   
   
      :c:struct:`~A3DGraphStyleData`
   
   
   
      :c:struct:`~A3DGraphPictureData`
   
   
   
      :c:struct:`~A3DGraphicsData`
   
   
   **Parameters**
   
   
      **uiIndexLinePattern**\ : The index of the line pattern descriptor
   
      **pData**\ : The ``A3DGraphLinePatternData`` to fill in.
   
   
   **Returns**
   
   
      ``A3D_SUCCESS`` or an error code in case of failure.
   
   




