<!-- $XConsortium: GetAtomN.sgm /main/7 1996/09/08 20:45:30 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->

<RefEntry Id="CDEMMA.MAN246.rsml.1">
<RefMeta>
<RefEntryTitle>XmGetAtomName</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmGetAtomName</Function></RefName>
<RefPurpose>A function that returns the string representation for an atom
<IndexTerm>
<Primary>XmGetAtomName</Primary>
</IndexTerm><IndexTerm>
<Primary>atoms</Primary>
</IndexTerm></RefPurpose>
</RefNameDiv>
<!-- -->
<!-- @OSF_COPYRIGHT@-->
<!-- COPYRIGHT NOTICE-->
<!-- Copyright (c) 1990, 1991, 1992, 1993 Open Software Foundation, Inc.-->
<!-- ALL RIGHTS RESERVED (MOTIF). See the file named COPY.MOTIF.DOC for-->
<!-- the full copyright text.-->
<!-- -->
<!-- HISTORY-->
<!-- -->
<!-- **-->
<!-- **-->
<!-- **  (c) Copyright 1989, 1990, 1992 by Open Software Foundation, Inc.-->
<!-- **      All Rights Reserved.-->
<!-- **-->
<!-- **  (c) Copyright 1987, 1988, 1989, by Hewlett-Packard Company-->
<!-- **-->
<!-- **  (c) Copyright 1987, 1988 by Digital Equipment Corporation,-->
<!-- **      Maynard, MA.  All Rights Reserved.-->
<!-- **-->
<!-- **-->
<RefSynopsisDiv>
<FuncSynopsis>
<FuncSynopsisInfo>#include &lt;Xm/Xm.h>
#include &lt;Xm/AtomMgr.h>
</FuncSynopsisInfo>
<FuncDef>String <Function>XmGetAtomName</Function></FuncDef>
<!--<ParamDef><Replaceable>display, atom</Replaceable></ParamDef>-->
<ParamDef>Display <Parameter>* display</Parameter></ParamDef>
<ParamDef>Atom <Parameter>atom</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmGetAtomName</Function> returns the string representation for an atom.
It mirrors the <Emphasis>Xlib</Emphasis> interfaces for atom management but provides
client-side caching. When and where caching is provided in <Emphasis>Xlib</Emphasis>, the
routines will become pseudonyms for the <Emphasis>Xlib</Emphasis> routines.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">display</Symbol></Term>
<ListItem>
<Para>Specifies the connection to the X server
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">atom</Symbol></Term>
<ListItem>
<Para>Specifies the atom for the property name you want returned
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>Returns a string.
The function allocates space to hold the returned string.
The application is responsible for managing the allocated space.
The application can recover the allocated space by calling <Function>XFree</Function>.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
