globalmapper.SetLayerUserText
=============================

.. currentmodule:: globalmapper
.. py:function:: SetLayerUserText (GM_LayerHandle_t32 aLayer, str aUserText) -> GM_Error_t32

    Sets a text string to associate with the layer. This value can be retrieved by calling
    :doc:`GetLayerInfo<../load/globalmapper.GetLayerInfo>`. This text string will persist through a save to a workspace
    with :doc:`SaveWorkspace<../load/globalmapper.SaveWorkspace>` so if you reload that workspace the same text
    string will be available. This is useful if you want to tie some text to the layer that persists through a save.

    :param GM_LayerHandle_t32 aLayer: layer to set user text for
    :param str aUserText: text string to set as text for layer
    :returns: Error Code
    :rtype: GM_Error_t32