.. highlightlang:: us

.. index:: LayerGetClip

.. _layergetclip:

LayerGetClip
============

.. us.tag  LayerGetClip NOTREADYENGLISH New300 LayerGet

:ref:`LayerGetClip` return the clipping flag. The flag gives an information
on which side of the diagram the datasets are clipped.

.. function::  nClip = LayerGetClip(hLayer)

.. us.return

**Return Value**

*nClip* is an OR combination of the following values.

.. list-table::
   :header-rows: 1

   * - Value
     - Description
   * - G_CLIP_LEFT
     - Clip at the left border
   * - G_CLIP_RIGHT
     - Clip at the right border
   * - G_CLIP_TOP
     - Clip at the top border
   * - G_CLIP_BOTTOM
     - Clip at the bottom border

The following example checks if clipping is set for the left and right border:

::

   nClip = LayerGetClip(hLayer);
   if (nClip & G_CLIP_LEFT && nClip & G_CLIP_RIGHT) {
       // Clipping is on
   }

.. us.params

**Parameters**

.. uparam:: hLayer

   *hLayer* is the handle of a diagram (layer).

.. seealso::
   :ref:`overview-application-object`,
   :ref:`LayerSetClip`

:sub:`id-711342`