<!-- $XConsortium: InternA.sgm /main/8 1996/09/25 10:03:28 cdedoc $ -->
<!-- (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.MAN277.rsml.1">
<RefMeta>
<RefEntryTitle>XmInternAtom</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmInternAtom</Function></RefName>
<RefPurpose>A macro that returns an atom for a given name
<IndexTerm>
<Primary>XmInternAtom</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/AtomMgr.h>
</FuncSynopsisInfo>
<FuncDef>Atom <Function>XmInternAtom</Function></FuncDef>
<!--<ParamDef><Replaceable>display, name, only_if_exists</Replaceable></ParamDef>-->
<ParamDef>Display <Parameter>* display</Parameter></ParamDef>
<ParamDef>String <Parameter>name</Parameter></ParamDef>
<ParamDef>Boolean <Parameter>only_if_exists</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmInternAtom</Function> returns an atom for a given name.
The returned atom remains defined even after the client's
connection closes. The returned atom becomes undefined when
the last connection to the X server closes.
</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">name</Symbol></Term>
<ListItem>
<Para>Specifies the name associated with the atom you want returned.
The value of <Symbol Role="Variable">name</Symbol> is case dependent.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">only_if_exists</Symbol></Term>
<ListItem>
<Para>Specifies a Boolean value.
If False, the atom is created even if it does not exist.
(If it does not exist, the returned atom will be <SystemItem Class="Constant">None</SystemItem>.)
If True, the atom is created only if it exists.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>Returns an atom.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
