
####################
A3DGraphSpotLightGet
####################

.. c:function:: A3DStatus A3DGraphSpotLightGet(const A3DGraphSpotLight *pLight, A3DGraphSpotLightData *pData)

   .. rst-class:: sig-pretty-signature
   
      | :c:enum:`~A3DStatus` A3DGraphSpotLightGet(*const* :c:type:`~A3DGraphSpotLight`\ \* **pLight**\ , :c:struct:`~A3DGraphSpotLightData`\ \* **pData**\ )
   
   Fetches data from a spotlight source entity given its handle.
   
   
      2.0
   
   
   **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_ENTITY_TYPE**\ : if the entity type ``pLight`` refers to is not ``kA3DTypeGraphSpotLight``
   
   
   .. code-block:: c
   
      // Retrieves the light data at index 3:
      A3DGraphSpotLightData light = A3D_MAKE_DATA(A3DGraphSpotLightData);
      A3DStatus result = A3DGraphSpotLightGet(3, &light);
      assert(result == A3D_SUCCESS);
   
   
   ..
   
      :c:struct:`~A3DGraphSpotLightData`
   
   
   
      :c:func:`~A3DGraphSpotLightCreate`
   
   
   
      :c:struct:`~A3DGraphAmbientLightData`
   
   
   
      :c:struct:`~A3DGraphDirectionalLightData`
   
   
   
      :c:struct:`~A3DGraphPointLightData`
   
   
   
      :c:struct:`~A3DGraphSceneDisplayParametersData`
   
   
   **Parameters**
   
   
      **pLight**\ : A handle to the light to fetch data from.
   
      **pData**\ : The ``A3DGraphSpotLightData`` to fill in.
   
   
   **Returns**
   
   
      ``A3D_SUCCESS`` or an error code in case of failure.
   
   




