man3/AFInternAtom.3

#

    AFInternAtom(3)						      AFInternAtom(3)

    NAME
      AFInternAtom,	AFGetAtomName -	create or return atom names

    SYNTAX
      #include <AF/AFlib.h>
      AAtom	AFInternAtom(AFAudioConn *aud, char *atom_name,	ABool only_if_exists)

      char *AFGetAtomName(AFAudioConn *aud,	AAtom atom)

    ARGUMENTS

      atom	    Specifies the atom for the property	name you want returned.

      atom_name Specifies the name associated with the atom	you want returned.

      aud	    Specifies the connection to	the AF server.

      only_if_exists
    	    Specifies a	Boolean	value that indicates whether AFInternAtom
    	    creates the	atom.

    DESCRIPTION
      The AFInternAtom function returns the	atom identifier	associated with	the
      specified atom_name string.  If only_if_exists is False, the atom is
      created if it	does not exist.	 Therefore, AFInternAtom can return ANone.
      If the atom name is not in the Host Portable Character Encoding the result
      is implementation dependent.	Case matters; the strings thing, Thing,	and
      thinG	all designate different	atoms. The atom	will remain defined even
      after	the client's connection	closes.

      AFInternAtom can generate ABadAlloc and ABadValue errors.

      The AFGetAtomName function returns the name associated with the specified
      atom.	 If the	data returned by the server is in the Latin Portable Charac-
      ter Encoding,	then the returned string is in the Host	Portable Character
      Encoding.  Otherwise,	the result is implementation dependent.	 To free the
      resulting string, call AFree.

      AFGetAtomName	can generate a BadAtom error.

    DIAGNOSTICS

      BadAlloc  The	server failed to allocate the requested	resource or server
    	    memory.

      ABadAtom  A value for	an AAtom argument does not name	a defined AAtom.

      ABadValue Some numeric value falls outside the range of values accepted by
    	    the	request.  Unless a specific range is specified for an argu-
    	    ment, the full range defined by the	argument's type	is accepted.
    	    Any	argument defined as a set of alternatives can generate this
    	    error.

    SEE ALSO
      AF(1), AFGetProperty(3)

    BUGS
      If you encounter a reproducible bug, please submit a problem report to
      (af-bugs@crl.dec.com).

    COPYRIGHT
      Copyright 1990-1994, Digital Equipment Corporation.
      See AF(1) for	a full statement of rights and permissions.

    AUTHORS
      Digital Cambridge Research Lab