Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

Tk_GetUid (3tk)

Name

Tk_GetUid - convert from string to unique identifier

Synopsis

#include <tk.h>

Tk_Uid
Tk_GetUid(string)

Description

Tk_GetUid(3tk)               Tk Library Procedures              Tk_GetUid(3tk)



______________________________________________________________________________

NAME
       Tk_GetUid, Tk_Uid - convert from string to unique identifier

SYNOPSIS
       #include <tk.h>

       Tk_Uid
       Tk_GetUid(string)

ARGUMENTS
       char *string (in)                         String  for  which the corre-
                                                 sponding unique identifier is
                                                 desired.
______________________________________________________________________________

DESCRIPTION
       Tk_GetUid  returns  the  unique  identifier  corresponding  to  string.
       Unique identifiers are similar to atoms in Lisp, and are used in Tk  to
       speed  up  comparisons and searches.  A unique identifier (type Tk_Uid)
       is a string pointer and may be used anywhere that a  variable  of  type
       "char *" could be used.  However, there is guaranteed to be exactly one
       unique identifier for any given string value.  If Tk_GetUid  is  called
       twice,  once  with string a and once with string b, and if a and b have
       the same string value (strcmp(a, b) == 0), then Tk_GetUid  will  return
       exactly   the   same  Tk_Uid  value  for  each  call  (Tk_GetUid(a)  ==
       Tk_GetUid(b)).  This means that variables of type Tk_Uid  may  be  com-
       pared  directly  (x  == y) without having to call strcmp.  In addition,
       the return value from Tk_GetUid will have the same string value as  its
       argument (strcmp(Tk_GetUid(a), a) == 0).

KEYWORDS
       atom, unique identifier



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | runtime/tk-8     |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source        was        downloaded        from         https://source-
       forge.net/projects/tcl/files/Tcl/8.6.7/tk8.6.7-src.tar.gz/download.

       Further information about this software can be found on the open source
       community website at https://www.tcl.tk/.



Tk                                                              Tk_GetUid(3tk)