Linux Manuals session 3

Section 3: library functions

  • |

    Tcl_SetCommandInfo (3) Linux Manual Page

    Tcl_CreateObjCommand, Tcl_DeleteCommand, Tcl_DeleteCommandFromToken, Tcl_GetCommandInfo, Tcl_GetCommandInfoFromToken, Tcl_SetCommandInfo, Tcl_SetCommandInfoFromToken, Tcl_GetCommandName, Tcl_GetCommandFullName, Tcl_GetCommandFromObj – implement new commands in C Synopsis #include <tcl.h> Tcl_Command Tcl_CreateObjCommand(interp, cmdName, proc, clientData, deleteProc) int Tcl_DeleteCommand(interp, cmdName) int Tcl_DeleteCommandFromToken(interp, token) int Tcl_GetCommandInfo(interp, cmdName, infoPtr) int Tcl_SetCommandInfo(interp, cmdName, infoPtr) int Tcl_GetCommandInfoFromToken(token, infoPtr) int Tcl_SetCommandInfoFromToken(token, infoPtr) const char * Tcl_GetCommandName(interp, token) void Tcl_GetCommandFullName(interp, token, objPtr) Tcl_Command…

  • |

    Tcl_SetChannelOption (3) Linux Manual Page

    Tcl_OpenFileChannel, Tcl_OpenCommandChannel, Tcl_MakeFileChannel, Tcl_GetChannel, Tcl_GetChannelNames, Tcl_GetChannelNamesEx, Tcl_RegisterChannel, Tcl_UnregisterChannel, Tcl_DetachChannel, Tcl_IsStandardChannel, Tcl_Close, Tcl_ReadChars, Tcl_Read, Tcl_GetsObj, Tcl_Gets, Tcl_WriteObj, Tcl_WriteChars, Tcl_Write, Tcl_Flush, Tcl_Seek, Tcl_Tell, Tcl_TruncateChannel, Tcl_GetChannelOption, Tcl_SetChannelOption, Tcl_Eof, Tcl_InputBlocked, Tcl_InputBuffered, Tcl_OutputBuffered, Tcl_Ungets, Tcl_ReadRaw, Tcl_WriteRaw – buffered I/O facilities using channels Synopsis #include <tcl.h> Tcl_Channel Tcl_OpenFileChannel(interp, fileName, mode, permissions) Tcl_Channel Tcl_OpenCommandChannel(interp, argc, argv, flags) Tcl_Channel Tcl_MakeFileChannel(handle, readOrWrite) Tcl_Channel Tcl_GetChannel(interp,…

  • |

    Tcl_SetChannelErrorInterp (3) Linux Manual Page

    Tcl_SetChannelError, Tcl_SetChannelErrorInterp, Tcl_GetChannelError, Tcl_GetChannelErrorInterp – functions to create/intercept Tcl errors by channel drivers. Synopsis #include <tcl.h> void Tcl_SetChannelError(chan, msg) void Tcl_SetChannelErrorInterp(interp, msg) void Tcl_GetChannelError(chan, msgPtr) void Tcl_GetChannelErrorInterp(interp, msgPtr) Arguments Tcl_Channel chan (in) Refers to the Tcl channel whose bypass area is accessed. Tcl_Interp* interp (in) Refers to the Tcl interpreter whose bypass area is accessed….

  • |

    Tcl_SetChannelError (3) Linux Manual Page

    Tcl_SetChannelError, Tcl_SetChannelErrorInterp, Tcl_GetChannelError, Tcl_GetChannelErrorInterp – functions to create/intercept Tcl errors by channel drivers. Synopsis #include <tcl.h> void Tcl_SetChannelError(chan, msg) void Tcl_SetChannelErrorInterp(interp, msg) void Tcl_GetChannelError(chan, msgPtr) void Tcl_GetChannelErrorInterp(interp, msgPtr) Arguments Tcl_Channel chan (in) Refers to the Tcl channel whose bypass area is accessed. Tcl_Interp* interp (in) Refers to the Tcl interpreter whose bypass area is accessed….

  • |

    Tcl_SetChannelBufferSize (3) Linux Manual Page

    Tcl_CreateChannel, Tcl_GetChannelInstanceData, Tcl_GetChannelType, Tcl_GetChannelName, Tcl_GetChannelHandle, Tcl_GetChannelMode, Tcl_GetChannelBufferSize, Tcl_SetChannelBufferSize, Tcl_NotifyChannel, Tcl_BadChannelOption, Tcl_ChannelName, Tcl_ChannelVersion, Tcl_ChannelBlockModeProc, Tcl_ChannelCloseProc, Tcl_ChannelClose2Proc, Tcl_ChannelInputProc, Tcl_ChannelOutputProc, Tcl_ChannelSeekProc, Tcl_ChannelWideSeekProc, Tcl_ChannelTruncateProc, Tcl_ChannelSetOptionProc, Tcl_ChannelGetOptionProc, Tcl_ChannelWatchProc, Tcl_ChannelGetHandleProc, Tcl_ChannelFlushProc, Tcl_ChannelHandlerProc, Tcl_ChannelThreadActionProc, Tcl_IsChannelShared, Tcl_IsChannelRegistered, Tcl_CutChannel, Tcl_SpliceChannel, Tcl_IsChannelExisting, Tcl_ClearChannelHandlers, Tcl_GetChannelThread, Tcl_ChannelBuffered – procedures for creating and manipulating channels Synopsis #include <tcl.h> Tcl_Channel Tcl_CreateChannel(typePtr, channelName, instanceData, mask) ClientData Tcl_GetChannelInstanceData(channel) Tcl_ChannelType * Tcl_GetChannelType(channel)…

  • |

    Tcl_SetByteArrayObj (3) Linux Manual Page

    Tcl_NewByteArrayObj, Tcl_SetByteArrayObj, Tcl_GetByteArrayFromObj, Tcl_SetByteArrayLength – manipulate Tcl objects as a arrays of bytes Synopsis #include <tcl.h> Tcl_Obj * Tcl_NewByteArrayObj(bytes, length) void Tcl_SetByteArrayObj(objPtr, bytes, length) unsigned char * Tcl_GetByteArrayFromObj(objPtr, lengthPtr) unsigned char * Tcl_SetByteArrayLength(objPtr, length) Arguments const unsigned char *bytes (in) The array of bytes used to initialize or set a byte-array object. int length (in)…

  • |

    Tcl_SetByteArrayLength (3) Linux Manual Page

    Tcl_NewByteArrayObj, Tcl_SetByteArrayObj, Tcl_GetByteArrayFromObj, Tcl_SetByteArrayLength – manipulate Tcl objects as a arrays of bytes Synopsis #include <tcl.h> Tcl_Obj * Tcl_NewByteArrayObj(bytes, length) void Tcl_SetByteArrayObj(objPtr, bytes, length) unsigned char * Tcl_GetByteArrayFromObj(objPtr, lengthPtr) unsigned char * Tcl_SetByteArrayLength(objPtr, length) Arguments const unsigned char *bytes (in) The array of bytes used to initialize or set a byte-array object. int length (in)…

  • |

    Tcl_SetBooleanObj (3) Linux Manual Page

    Tcl_NewBooleanObj, Tcl_SetBooleanObj, Tcl_GetBooleanFromObj – store/retrieve boolean value in a Tcl_Obj Synopsis #include <tcl.h> Tcl_Obj * Tcl_NewBooleanObj(boolValue) Tcl_SetBooleanObj(objPtr, boolValue) int Tcl_GetBooleanFromObj(interp, objPtr, boolPtr) Arguments int boolValue (in) Integer value to be stored as a boolean value in a Tcl_Obj. Tcl_Obj *objPtr (in/out) Points to the Tcl_Obj in which to store, or from which to retrieve a…

  • |

    Tcl_SetBignumObj (3) Linux Manual Page

    Tcl_NewIntObj, Tcl_NewLongObj, Tcl_NewWideIntObj, Tcl_SetIntObj, Tcl_SetLongObj, Tcl_SetWideIntObj, Tcl_GetIntFromObj, Tcl_GetLongFromObj, Tcl_GetWideIntFromObj, Tcl_NewBignumObj, Tcl_SetBignumObj, Tcl_GetBignumFromObj, Tcl_TakeBignumFromObj – manipulate Tcl objects as integer values Synopsis #include <tcl.h> Tcl_Obj * Tcl_NewIntObj(intValue) Tcl_Obj * Tcl_NewLongObj(longValue) Tcl_Obj * Tcl_NewWideIntObj(wideValue) Tcl_SetIntObj(objPtr, intValue) Tcl_SetLongObj(objPtr, longValue) Tcl_SetWideIntObj(objPtr, wideValue) int Tcl_GetIntFromObj(interp, objPtr, intPtr) int Tcl_GetLongFromObj(interp, objPtr, longPtr) int Tcl_GetWideIntFromObj(interp, objPtr, widePtr) #include <tclTomMath.h> Tcl_Obj * Tcl_NewBignumObj(bigValue)…

  • |

    Tcl_SetAssocData (3) Linux Manual Page

    Tcl_GetAssocData, Tcl_SetAssocData, Tcl_DeleteAssocData – manage associations of string keys and user specified data with Tcl interpreters Synopsis #include <tcl.h> ClientData Tcl_GetAssocData(interp, key, delProcPtr) Tcl_SetAssocData(interp, key, delProc, clientData) Tcl_DeleteAssocData(interp, key) Arguments Tcl_Interp *interp (in) Interpreter in which to execute the specified command. const char *key (in) Key for association with which to store data or from…

  • |

    Tcl_ServiceModeHook (3) Linux Manual Page

    Tcl_CreateEventSource, Tcl_DeleteEventSource, Tcl_SetMaxBlockTime, Tcl_QueueEvent, Tcl_ThreadQueueEvent, Tcl_ThreadAlert, Tcl_GetCurrentThread, Tcl_DeleteEvents, Tcl_InitNotifier, Tcl_FinalizeNotifier, Tcl_WaitForEvent, Tcl_AlertNotifier, Tcl_SetTimer, Tcl_ServiceAll, Tcl_ServiceEvent, Tcl_GetServiceMode, Tcl_SetServiceMode, Tcl_ServiceModeHook, Tcl_SetNotifier – the event queue and notifier interfaces Synopsis #include <tcl.h> void Tcl_CreateEventSource(setupProc, checkProc, clientData) void Tcl_DeleteEventSource(setupProc, checkProc, clientData) void Tcl_SetMaxBlockTime(timePtr) void Tcl_QueueEvent(evPtr, position) void Tcl_ThreadQueueEvent(threadId, evPtr, position) void Tcl_ThreadAlert(threadId) Tcl_ThreadId Tcl_GetCurrentThread() void Tcl_DeleteEvents(deleteProc, clientData) ClientData Tcl_InitNotifier()…

  • |

    Tcl_ServiceEvent (3) Linux Manual Page

    Tcl_CreateEventSource, Tcl_DeleteEventSource, Tcl_SetMaxBlockTime, Tcl_QueueEvent, Tcl_ThreadQueueEvent, Tcl_ThreadAlert, Tcl_GetCurrentThread, Tcl_DeleteEvents, Tcl_InitNotifier, Tcl_FinalizeNotifier, Tcl_WaitForEvent, Tcl_AlertNotifier, Tcl_SetTimer, Tcl_ServiceAll, Tcl_ServiceEvent, Tcl_GetServiceMode, Tcl_SetServiceMode – the event queue and notifier interfaces Synopsis #include <tcl.h> void Tcl_CreateEventSource(setupProc, checkProc, clientData) void Tcl_DeleteEventSource(setupProc, checkProc, clientData) void Tcl_SetMaxBlockTime(timePtr) void Tcl_QueueEvent(evPtr, position) void Tcl_ThreadQueueEvent(threadId, evPtr, position) void Tcl_ThreadAlert(threadId) Tcl_ThreadId Tcl_GetCurrentThread() void Tcl_DeleteEvents(deleteProc, clientData) ClientData Tcl_InitNotifier() void Tcl_FinalizeNotifier(clientData)…

  • |

    Tcl_ServiceAll (3) Linux Manual Page

    Tcl_CreateEventSource, Tcl_DeleteEventSource, Tcl_SetMaxBlockTime, Tcl_QueueEvent, Tcl_ThreadQueueEvent, Tcl_ThreadAlert, Tcl_GetCurrentThread, Tcl_DeleteEvents, Tcl_InitNotifier, Tcl_FinalizeNotifier, Tcl_WaitForEvent, Tcl_AlertNotifier, Tcl_SetTimer, Tcl_ServiceAll, Tcl_ServiceEvent, Tcl_GetServiceMode, Tcl_SetServiceMode – the event queue and notifier interfaces Synopsis #include <tcl.h> void Tcl_CreateEventSource(setupProc, checkProc, clientData) void Tcl_DeleteEventSource(setupProc, checkProc, clientData) void Tcl_SetMaxBlockTime(timePtr) void Tcl_QueueEvent(evPtr, position) void Tcl_ThreadQueueEvent(threadId, evPtr, position) void Tcl_ThreadAlert(threadId) Tcl_ThreadId Tcl_GetCurrentThread() void Tcl_DeleteEvents(deleteProc, clientData) ClientData Tcl_InitNotifier() void Tcl_FinalizeNotifier(clientData)…

  • |

    Tcl_Seek (3) Linux Manual Page

    Tcl_OpenFileChannel, Tcl_OpenCommandChannel, Tcl_MakeFileChannel, Tcl_GetChannel, Tcl_GetChannelNames, Tcl_GetChannelNamesEx, Tcl_RegisterChannel, Tcl_UnregisterChannel, Tcl_DetachChannel, Tcl_IsStandardChannel, Tcl_Close, Tcl_ReadChars, Tcl_Read, Tcl_GetsObj, Tcl_Gets, Tcl_WriteObj, Tcl_WriteChars, Tcl_Write, Tcl_Flush, Tcl_Seek, Tcl_Tell, Tcl_TruncateChannel, Tcl_GetChannelOption, Tcl_SetChannelOption, Tcl_Eof, Tcl_InputBlocked, Tcl_InputBuffered, Tcl_OutputBuffered, Tcl_Ungets, Tcl_ReadRaw, Tcl_WriteRaw – buffered I/O facilities using channels Synopsis #include <tcl.h> Tcl_Channel Tcl_OpenFileChannel(interp, fileName, mode, permissions) Tcl_Channel Tcl_OpenCommandChannel(interp, argc, argv, flags) Tcl_Channel Tcl_MakeFileChannel(handle, readOrWrite) Tcl_Channel Tcl_GetChannel(interp,…

  • |

    Tcl_ScanElement (3) Linux Manual Page

    Tcl_SplitList, Tcl_Merge, Tcl_ScanElement, Tcl_ConvertElement, Tcl_ScanCountedElement, Tcl_ConvertCountedElement – manipulate Tcl lists Synopsis #include <tcl.h> int Tcl_SplitList(interp, list, argcPtr, argvPtr) char * Tcl_Merge(argc, argv) int Tcl_ScanElement(src, flagsPtr) int Tcl_ScanCountedElement(src, length, flagsPtr) int Tcl_ConvertElement(src, dst, flags) int Tcl_ConvertCountedElement(src, length, dst, flags) Arguments Tcl_Interp *interp (out) Interpreter to use for error reporting. If NULL, then no error message is…

  • |

    Tcl_ScanCountedElement (3) Linux Manual Page

    Tcl_SplitList, Tcl_Merge, Tcl_ScanElement, Tcl_ConvertElement, Tcl_ScanCountedElement, Tcl_ConvertCountedElement – manipulate Tcl lists Synopsis #include <tcl.h> int Tcl_SplitList(interp, list, argcPtr, argvPtr) char * Tcl_Merge(argc, argv) int Tcl_ScanElement(src, flagsPtr) int Tcl_ScanCountedElement(src, length, flagsPtr) int Tcl_ConvertElement(src, dst, flags) int Tcl_ConvertCountedElement(src, length, dst, flags) Arguments Tcl_Interp *interp (out) Interpreter to use for error reporting. If NULL, then no error message is…

  • |

    Tcl_SaveResult (3) Linux Manual Page

    Tcl_SaveInterpState, Tcl_RestoreInterpState, Tcl_DiscardInterpState, Tcl_SaveResult, Tcl_RestoreResult, Tcl_DiscardResult – save and restore an interpreter’s state Synopsis #include <tcl.h> Tcl_InterpState Tcl_SaveInterpState(interp, status) int Tcl_RestoreInterpState(interp, state) Tcl_DiscardInterpState(state) Tcl_SaveResult(interp, savedPtr) Tcl_RestoreResult(interp, savedPtr) Tcl_DiscardResult(savedPtr) Arguments Tcl_Interp *interp (in) Interpreter for which state should be saved. int status (in) Return code value to save as part of interpreter state. Tcl_InterpState state (in)…

  • |

    Tcl_SaveInterpState (3) Linux Manual Page

    Tcl_SaveInterpState, Tcl_RestoreInterpState, Tcl_DiscardInterpState, Tcl_SaveResult, Tcl_RestoreResult, Tcl_DiscardResult – save and restore an interpreter’s state Synopsis #include <tcl.h> Tcl_InterpState Tcl_SaveInterpState(interp, status) int Tcl_RestoreInterpState(interp, state) Tcl_DiscardInterpState(state) Tcl_SaveResult(interp, savedPtr) Tcl_RestoreResult(interp, savedPtr) Tcl_DiscardResult(savedPtr) Arguments Tcl_Interp *interp (in) Interpreter for which state should be saved. int status (in) Return code value to save as part of interpreter state. Tcl_InterpState state (in)…

  • |

    Tcl_RestoreResult (3) Linux Manual Page

    Tcl_SaveInterpState, Tcl_RestoreInterpState, Tcl_DiscardInterpState, Tcl_SaveResult, Tcl_RestoreResult, Tcl_DiscardResult – save and restore an interpreter’s state Synopsis #include <tcl.h> Tcl_InterpState Tcl_SaveInterpState(interp, status) int Tcl_RestoreInterpState(interp, state) Tcl_DiscardInterpState(state) Tcl_SaveResult(interp, savedPtr) Tcl_RestoreResult(interp, savedPtr) Tcl_DiscardResult(savedPtr) Arguments Tcl_Interp *interp (in) Interpreter for which state should be saved. int status (in) Return code value to save as part of interpreter state. Tcl_InterpState state (in)…

  • |

    Tcl_RestoreInterpState (3) Linux Manual Page

    Tcl_SaveInterpState, Tcl_RestoreInterpState, Tcl_DiscardInterpState, Tcl_SaveResult, Tcl_RestoreResult, Tcl_DiscardResult – save and restore an interpreter’s state Synopsis #include <tcl.h> Tcl_InterpState Tcl_SaveInterpState(interp, status) int Tcl_RestoreInterpState(interp, state) Tcl_DiscardInterpState(state) Tcl_SaveResult(interp, savedPtr) Tcl_RestoreResult(interp, savedPtr) Tcl_DiscardResult(savedPtr) Arguments Tcl_Interp *interp (in) Interpreter for which state should be saved. int status (in) Return code value to save as part of interpreter state. Tcl_InterpState state (in)…