Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

tt_objid_objkey (3)

Name

tt_objid_objkey - return the unique key of an objid

Synopsis

#include <Tt/tt_c.h>
char *tt_objid_objkey(const char *objid);

Description

tt_objid_objkey(3)            ToolTalk Functions            tt_objid_objkey(3)



NAME
       tt_objid_objkey - return the unique key of an objid

SYNOPSIS
       #include <Tt/tt_c.h>
       char *tt_objid_objkey(const char *objid);

DESCRIPTION
       The tt_objid_objkey() function returns the unique key of an objid.

       The  objid  argument  is  the identifier of the object involved in this
       operation.

RETURN VALUE
       Upon successful completion, the tt_objid_objkey() function returns  the
       unique  key of the objid.  No two objids have the same unique key.  The
       application can use tt_ptr_error(3) to extract  one  of  the  following
       Tt_status values from the returned pointer:

          TT_OK   The operation completed successfully.

          TT_ERR_OBJID
                  The  objid passed to the ToolTalk service does not reference
                  an existing object spec.

APPLICATION USAGE
       The application should use tt_free(3) to free any data  stored  in  the
       address returned by the ToolTalk API.


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


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/tooltalk |
       +---------------+------------------+
       |Stability      | Committed        |
       +---------------+------------------+

SEE ALSO
       tt_c(5), tt_ptr_error(3), tt_free(3).




ToolTalk 1.3                     1 March 1996               tt_objid_objkey(3)