Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

Tcl_OOInitStubs (3tcl)

Name

Tcl_OOInitStubs - initialize library access to TclOO functionality

Synopsis

#include <tclOO.h>

const char *
Tcl_OOInitStubs(interp)

Description

Tcl_OOInitStubs(3tcl)       TclOO Library Functions      Tcl_OOInitStubs(3tcl)



______________________________________________________________________________

NAME
       Tcl_OOInitStubs - initialize library access to TclOO functionality

SYNOPSIS
       #include <tclOO.h>

       const char *
       Tcl_OOInitStubs(interp)

ARGUMENTS
       Tcl_Interp *interp (in)          The Tcl interpreter that the TclOO API
                                        is integrated with and whose C  inter-
                                        face is going to be used.
______________________________________________________________________________

DESCRIPTION
       When  an  extension  library is going to use the C interface exposed by
       TclOO, it should use Tcl_OOInitStubs to initialize its access  to  that
       interface  from  within its *_Init (or *_SafeInit) function, passing in
       the interp that was passed into that routine as context. If the  result
       of  calling  Tcl_OOInitStubs  is NULL, the initialization failed and an
       error message will have been left in the interpreter's  result.  Other-
       wise,  the initialization succeeded and the TclOO API may thereafter be
       used; the version of the TclOO API is returned.

       When using this function, either the C #define  symbol  USE_TCLOO_STUBS
       should  be  defined  and  your library code linked against the Tcl stub
       library, or that #define symbol should not be defined and your  library
       code linked against the Tcl main library directly.

BACKWARD COMPATIBILITY NOTE
       If  you  are  linking against the Tcl 8.5 forward compatibility package
       for TclOO, only the stub-enabled configuration  is  supported  and  you
       should  also  link  against  the  TclOO  independent stub library; that
       library is an integrated part of the main Tcl stub library in Tcl 8.6.

KEYWORDS
       stubs


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


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

SEE ALSO
       Tcl_InitStubs(3)



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  http://prdownloads.sourceforge.net/tcl/tcl-
       core8.6.7-src.tar.gz.

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



TclOO                                 1.0                Tcl_OOInitStubs(3tcl)