Linux Manuals session 3

Section 3: library functions

  • |

    Tcl_SetVar (3) Linux Manual Page

    Tcl_SetVar2Ex, Tcl_SetVar, Tcl_SetVar2, Tcl_ObjSetVar2, Tcl_GetVar2Ex, Tcl_GetVar, Tcl_GetVar2, Tcl_ObjGetVar2, Tcl_UnsetVar, Tcl_UnsetVar2 – manipulate Tcl variables Synopsis#include <tcl.h> Tcl_Obj * Tcl_SetVar2Ex(interp, name1, name2, newValuePtr, flags) const char * Tcl_SetVar(interp, varName, newValue, flags) const char * Tcl_SetVar2(interp, name1, name2, newValue, flags) Tcl_Obj * Tcl_ObjSetVar2(interp, part1Ptr, part2Ptr, newValuePtr, flags) Tcl_Obj * Tcl_GetVar2Ex(interp, name1, name2, flags) const char * Tcl_GetVar(interp,…

  • |

    Tcl_SetUnicodeObj (3) Linux Manual Page

    Tcl_NewStringObj, Tcl_NewUnicodeObj, Tcl_SetStringObj, Tcl_SetUnicodeObj, Tcl_GetStringFromObj, Tcl_GetString, Tcl_GetUnicodeFromObj, Tcl_GetUnicode, Tcl_GetUniChar, Tcl_GetCharLength, Tcl_GetRange, Tcl_AppendToObj, Tcl_AppendUnicodeToObj, Tcl_AppendObjToObj, Tcl_AppendStringsToObj, Tcl_AppendStringsToObjVA, Tcl_AppendLimitedToObj, Tcl_Format, Tcl_AppendFormatToObj, Tcl_ObjPrintf, Tcl_AppendPrintfToObj, Tcl_SetObjLength, Tcl_AttemptSetObjLength, Tcl_ConcatObj – manipulate Tcl objects as strings Synopsis#include <tcl.h> Tcl_Obj * Tcl_NewStringObj(bytes, length) Tcl_Obj * Tcl_NewUnicodeObj(unicode, numChars) void Tcl_SetStringObj(objPtr, bytes, length) void Tcl_SetUnicodeObj(objPtr, unicode, numChars) char * Tcl_GetStringFromObj(objPtr, lengthPtr) char * Tcl_GetString(objPtr)…

  • |

    Tcl_SetTimer (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) int…

  • |

    Tcl_SetTimeProc (3) Linux Manual Page

    Tcl_GetTime, Tcl_SetTimeProc, Tcl_QueryTimeProc – get date and time Synopsis#include <tcl.h> Tcl_GetTime(timePtr) Tcl_SetTimeProc(getProc, scaleProc, clientData) Tcl_QueryTimeProc(getProcPtr, scaleProcPtr, clientDataPtr)ArgumentsTcl_Time * timePtr (out) Points to memory in which to store the date and time information. Tcl_GetTimeProc * getProc (in) Pointer to handler function replacing Tcl_GetTime‘s access to the OS. Tcl_ScaleTimeProc * scaleProc (in) Pointer to handler function for…

  • |

    Tcl_SetSystemEncoding (3) Linux Manual Page

    Tcl_GetEncoding, Tcl_FreeEncoding, Tcl_GetEncodingFromObj, Tcl_ExternalToUtfDString, Tcl_ExternalToUtf, Tcl_UtfToExternalDString, Tcl_UtfToExternal, Tcl_WinTCharToUtf, Tcl_WinUtfToTChar, Tcl_GetEncodingName, Tcl_SetSystemEncoding, Tcl_GetEncodingNameFromEnvironment, Tcl_GetEncodingNames, Tcl_CreateEncoding, Tcl_GetEncodingSearchPath, Tcl_SetEncodingSearchPath, Tcl_GetDefaultEncodingDir, Tcl_SetDefaultEncodingDir – procedures for creating and using encodings Synopsis#include <tcl.h> Tcl_Encoding Tcl_GetEncoding(interp, name) void Tcl_FreeEncoding(encoding) int Tcl_GetEncodingFromObj(interp, objPtr, encodingPtr) char * Tcl_ExternalToUtfDString(encoding, src, srcLen, dstPtr) char * Tcl_UtfToExternalDString(encoding, src, srcLen, dstPtr) int Tcl_ExternalToUtf(interp, encoding, src, srcLen, flags, statePtr,…

  • |

    Tcl_SetStringObj (3) Linux Manual Page

    Tcl_NewStringObj, Tcl_NewUnicodeObj, Tcl_SetStringObj, Tcl_SetUnicodeObj, Tcl_GetStringFromObj, Tcl_GetString, Tcl_GetUnicodeFromObj, Tcl_GetUnicode, Tcl_GetUniChar, Tcl_GetCharLength, Tcl_GetRange, Tcl_AppendToObj, Tcl_AppendUnicodeToObj, Tcl_AppendObjToObj, Tcl_AppendStringsToObj, Tcl_AppendStringsToObjVA, Tcl_AppendLimitedToObj, Tcl_Format, Tcl_AppendFormatToObj, Tcl_ObjPrintf, Tcl_AppendPrintfToObj, Tcl_SetObjLength, Tcl_AttemptSetObjLength, Tcl_ConcatObj – manipulate Tcl objects as strings Synopsis#include <tcl.h> Tcl_Obj * Tcl_NewStringObj(bytes, length) Tcl_Obj * Tcl_NewUnicodeObj(unicode, numChars) void Tcl_SetStringObj(objPtr, bytes, length) void Tcl_SetUnicodeObj(objPtr, unicode, numChars) char * Tcl_GetStringFromObj(objPtr, lengthPtr) char * Tcl_GetString(objPtr)…

  • |

    Tcl_SetStdChannel (3) Linux Manual Page

    Tcl_GetStdChannel, Tcl_SetStdChannel – procedures for retrieving and replacing the standard channels Synopsis#include <tcl.h> Tcl_Channel Tcl_GetStdChannel(type) Tcl_SetStdChannel(channel, type)Argumentsint type (in) The identifier for the standard channel to retrieve or modify. Must be one of TCL_STDIN, TCL_STDOUT, or TCL_STDERR. Tcl_Channel channel (in) The channel to use as the new value for the specified standard channel. DescriptionTcl defines…

  • |

    Tcl_SetStartupScript (3) Linux Manual Page

    Tcl_Main, Tcl_SetStartupScript, Tcl_GetStartupScript, Tcl_SetMainLoop – main program, startup script, and event loop definition for Tcl-based applications Synopsis#include <tcl.h> Tcl_Main(argc, argv, appInitProc) Tcl_SetStartupScript(path, encoding) Tcl_Obj * Tcl_GetStartupScript(encodingPtr) Tcl_SetMainLoop(mainLoopProc)Argumentsint argc (in) Number of elements in argv. char *argv[] (in) Array of strings containing command-line arguments. On Windows, when using -DUNICODE, the parameter type changes to wchar_t *….

  • |

    Tcl_SetServiceMode (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) int…

  • |

    Tcl_SetReturnOptions (3) Linux Manual Page

    Tcl_GetReturnOptions, Tcl_SetReturnOptions, Tcl_AddErrorInfo, Tcl_AppendObjToErrorInfo, Tcl_AddObjErrorInfo, Tcl_SetObjErrorCode, Tcl_SetErrorCode, Tcl_SetErrorCodeVA, Tcl_PosixError, Tcl_LogCommandInfo – retrieve or record information about errors and other return options Synopsis#include <tcl.h> Tcl_Obj * Tcl_GetReturnOptions(interp, code) int Tcl_SetReturnOptions(interp, options) Tcl_AddErrorInfo(interp, message) Tcl_AppendObjToErrorInfo(interp, objPtr) Tcl_AddObjErrorInfo(interp, message, length) Tcl_SetObjErrorCode(interp, errorObjPtr) Tcl_SetErrorCode(interp, element, element, … (char *) NULL) Tcl_SetErrorCodeVA(interp, argList) const char * Tcl_PosixError(interp) void Tcl_LogCommandInfo(interp, script,…

  • |

    Tcl_SetResult (3) Linux Manual Page

    Tcl_SetObjResult, Tcl_GetObjResult, Tcl_SetResult, Tcl_GetStringResult, Tcl_AppendResult, Tcl_AppendResultVA, Tcl_AppendElement, Tcl_ResetResult, Tcl_FreeResult – manipulate Tcl result Synopsis#include <tcl.h> Tcl_SetObjResult(interp, objPtr) Tcl_Obj * Tcl_GetObjResult(interp) Tcl_SetResult(interp, result, freeProc) const char * Tcl_GetStringResult(interp) Tcl_AppendResult(interp, result, result, … , (char *) NULL) Tcl_AppendResultVA(interp, argList) Tcl_AppendElement(interp, element) Tcl_ResetResult(interp) Tcl_FreeResult(interp)ArgumentsTcl_Interp *interp (out) Interpreter whose result is to be modified or read. Tcl_Obj *objPtr (in)…

  • |

    Tcl_SetRecursionLimit (3) Linux Manual Page

    Tcl_SetRecursionLimit – set maximum allowable nesting depth in interpreter Synopsis#include <tcl.h> int Tcl_SetRecursionLimit(interp, depth)ArgumentsTcl_Interp *interp (in) Interpreter whose recursion limit is to be set. Must be greater than zero. int depth (in) New limit for nested calls to Tcl_Eval for interp. DescriptionAt any given time Tcl enforces a limit on the number of recursive calls…

  • |

    Tcl_SetPanicProc (3) Linux Manual Page

    Tcl_Panic, Tcl_PanicVA, Tcl_SetPanicProc – report fatal error and abort Synopsis#include <tcl.h> void Tcl_Panic(format, arg, arg, …) void Tcl_PanicVA(format, argList) void Tcl_SetPanicProc(panicProc)Argumentsconst char* format (in) A printf-style format string. arg (in) Arguments matching the format string. va_list argList (in) An argument list of arguments matching the format string. Must have been initialized using va_start, and cleared…

  • |

    Tcl_SetObjResult (3) Linux Manual Page

    Tcl_SetObjResult, Tcl_GetObjResult, Tcl_SetResult, Tcl_GetStringResult, Tcl_AppendResult, Tcl_AppendResultVA, Tcl_AppendElement, Tcl_ResetResult, Tcl_FreeResult – manipulate Tcl result Synopsis#include <tcl.h> Tcl_SetObjResult(interp, objPtr) Tcl_Obj * Tcl_GetObjResult(interp) Tcl_SetResult(interp, result, freeProc) const char * Tcl_GetStringResult(interp) Tcl_AppendResult(interp, result, result, … , (char *) NULL) Tcl_AppendResultVA(interp, argList) Tcl_AppendElement(interp, element) Tcl_ResetResult(interp) Tcl_FreeResult(interp)ArgumentsTcl_Interp *interp (out) Interpreter whose result is to be modified or read. Tcl_Obj *objPtr (in)…

  • |

    Tcl_SetObjLength (3) Linux Manual Page

    Tcl_NewStringObj, Tcl_NewUnicodeObj, Tcl_SetStringObj, Tcl_SetUnicodeObj, Tcl_GetStringFromObj, Tcl_GetString, Tcl_GetUnicodeFromObj, Tcl_GetUnicode, Tcl_GetUniChar, Tcl_GetCharLength, Tcl_GetRange, Tcl_AppendToObj, Tcl_AppendUnicodeToObj, Tcl_AppendObjToObj, Tcl_AppendStringsToObj, Tcl_AppendStringsToObjVA, Tcl_AppendLimitedToObj, Tcl_Format, Tcl_AppendFormatToObj, Tcl_ObjPrintf, Tcl_AppendPrintfToObj, Tcl_SetObjLength, Tcl_AttemptSetObjLength, Tcl_ConcatObj – manipulate Tcl objects as strings Synopsis#include <tcl.h> Tcl_Obj * Tcl_NewStringObj(bytes, length) Tcl_Obj * Tcl_NewUnicodeObj(unicode, numChars) void Tcl_SetStringObj(objPtr, bytes, length) void Tcl_SetUnicodeObj(objPtr, unicode, numChars) char * Tcl_GetStringFromObj(objPtr, lengthPtr) char * Tcl_GetString(objPtr)…

  • |

    Tcl_SetObjErrorCode (3) Linux Manual Page

    Tcl_GetReturnOptions, Tcl_SetReturnOptions, Tcl_AddErrorInfo, Tcl_AppendObjToErrorInfo, Tcl_AddObjErrorInfo, Tcl_SetObjErrorCode, Tcl_SetErrorCode, Tcl_SetErrorCodeVA, Tcl_PosixError, Tcl_LogCommandInfo – retrieve or record information about errors and other return options Synopsis#include <tcl.h> Tcl_Obj * Tcl_GetReturnOptions(interp, code) int Tcl_SetReturnOptions(interp, options) Tcl_AddErrorInfo(interp, message) Tcl_AppendObjToErrorInfo(interp, objPtr) Tcl_AddObjErrorInfo(interp, message, length) Tcl_SetObjErrorCode(interp, errorObjPtr) Tcl_SetErrorCode(interp, element, element, … (char *) NULL) Tcl_SetErrorCodeVA(interp, argList) const char * Tcl_PosixError(interp) void Tcl_LogCommandInfo(interp, script,…

  • |

    Tcl_SetNotifier (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() void…

  • |

    Tcl_SetNamespaceUnknownHandler (3) Linux Manual Page

    Tcl_AppendExportList, Tcl_CreateNamespace, Tcl_DeleteNamespace, Tcl_Export, Tcl_FindCommand, Tcl_FindNamespace, Tcl_ForgetImport, Tcl_GetCurrentNamespace, Tcl_GetGlobalNamespace, Tcl_GetNamespaceUnknownHandler, Tcl_Import, Tcl_SetNamespaceUnknownHandler – manipulate namespaces Synopsis#include <tcl.h> Tcl_Namespace * Tcl_CreateNamespace(interp, name, clientData, deleteProc) Tcl_DeleteNamespace(nsPtr) int Tcl_AppendExportList(interp, nsPtr, objPtr) int Tcl_Export(interp, nsPtr, pattern, resetListFirst) int Tcl_Import(interp, nsPtr, pattern, allowOverwrite) int Tcl_ForgetImport(interp, nsPtr, pattern) Tcl_Namespace * Tcl_GetCurrentNamespace(interp) Tcl_Namespace * Tcl_GetGlobalNamespace(interp) Tcl_Namespace * Tcl_FindNamespace(interp, name, contextNsPtr, flags) Tcl_Command…

  • |

    Tcl_SetMaxBlockTime (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) int…

  • |

    Tcl_SetMainLoop (3) Linux Manual Page

    Tcl_Main, Tcl_SetMainLoop – main program and event loop definition for Tcl-based applications Synopsis#include <tcl.h> Tcl_Main(argc, argv, appInitProc) Tcl_SetMainLoop(mainLoopProc)Argumentsint argc (in) Number of elements in argv. char *argv[] (in) Array of strings containing command-line arguments. Tcl_AppInitProc *appInitProc (in) Address of an application-specific initialization procedure. The value for this argument is usually Tcl_AppInit. Tcl_MainLoopProc *mainLoopProc (in) Address…