Section 3: library functions
Tcl_SetErrno, Tcl_GetErrno, Tcl_ErrnoId, Tcl_ErrnoMsg – manipulate errno to store and retrieve error codes Synopsis #include <tcl.h> void Tcl_SetErrno(errorCode) int Tcl_GetErrno() const char * Tcl_ErrnoId() const char * Tcl_ErrnoMsg(errorCode) Arguments int errorCode (in) A POSIX error code such as ENOENT. Description Tcl_SetErrno and Tcl_GetErrno provide portable access to the errno variable, which is used to record…
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_NewObj, Tcl_DuplicateObj, Tcl_IncrRefCount, Tcl_DecrRefCount, Tcl_IsShared, Tcl_InvalidateStringRep – manipulate Tcl objects Synopsis #include <tcl.h> Tcl_Obj * Tcl_NewObj() Tcl_Obj * Tcl_DuplicateObj(objPtr) Tcl_IncrRefCount(objPtr) Tcl_DecrRefCount(objPtr) int Tcl_IsShared(objPtr) Tcl_InvalidateStringRep(objPtr) Arguments Tcl_Obj *objPtr (in) Points to an object; must have been the result of a previous call to Tcl_NewObj. Introduction This man page presents an overview of Tcl objects and how…
Tcl_DumpActiveMemory, Tcl_InitMemory, Tcl_ValidateAllMemory – Validated memory allocation interface Synopsis #include <tcl.h> int Tcl_DumpActiveMemory(fileName) void Tcl_InitMemory(interp) void Tcl_ValidateAllMemory(fileName, line) Arguments Tcl_Interp *interp (in) Tcl interpreter in which to add commands. const char *fileName (in) For Tcl_DumpActiveMemory, name of the file to which memory information will be written. For Tcl_ValidateAllMemory, name of the file from which the…
Tcl_CallWhenDeleted, Tcl_DontCallWhenDeleted – Arrange for callback when interpreter is deleted Synopsis #include <tcl.h> Tcl_CallWhenDeleted(interp, proc, clientData) Tcl_DontCallWhenDeleted(interp, proc, clientData) Arguments Tcl_Interp *interp (in) Interpreter with which to associated callback. Tcl_InterpDeleteProc *proc (in) Procedure to call when interp is deleted. ClientData clientData (in) Arbitrary one-word value to pass to proc. Description Tcl_CallWhenDeleted arranges for proc to…
Tcl_DoWhenIdle, Tcl_CancelIdleCall – invoke a procedure when there are no pending events Synopsis #include <tcl.h> Tcl_DoWhenIdle(proc, clientData) Tcl_CancelIdleCall(proc, clientData) Arguments Tcl_IdleProc *proc (in) Procedure to invoke. ClientData clientData (in) Arbitrary one-word value to pass to proc. Description Tcl_DoWhenIdle arranges for proc to be invoked when the application becomes idle. The application is considered to be…
Tcl_DoOneEvent – wait for events and invoke event handlers Synopsis #include <tcl.h> int Tcl_DoOneEvent(flags) Arguments int flags (in) This parameter is normally zero. It may be an OR-ed combination of any of the following flag bits: TCL_WINDOW_EVENTS, TCL_FILE_EVENTS, TCL_TIMER_EVENTS, TCL_IDLE_EVENTS, TCL_ALL_EVENTS, or TCL_DONT_WAIT. Description This procedure is the entry point to Tcl’s event loop; it…
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, 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_NewDictObj, Tcl_DictObjPut, Tcl_DictObjGet, Tcl_DictObjRemove, Tcl_DictObjSize, Tcl_DictObjFirst, Tcl_DictObjNext, Tcl_DictObjDone, Tcl_DictObjPutKeyList, Tcl_DictObjRemoveKeyList – manipulate Tcl objects as dictionaries Synopsis #include <tcl.h> Tcl_Obj * Tcl_NewDictObj() int Tcl_DictObjGet(interp, dictPtr, keyPtr, valuePtrPtr) int Tcl_DictObjPut(interp, dictPtr, keyPtr, valuePtr) int Tcl_DictObjRemove(interp, dictPtr, keyPtr) int Tcl_DictObjSize(interp, dictPtr, sizePtr) int Tcl_DictObjFirst(interp, dictPtr, searchPtr, keyPtrPtr, valuePtrPtr, donePtr) void Tcl_DictObjNext(searchPtr, keyPtrPtr, valuePtrPtr, donePtr) void Tcl_DictObjDone(searchPtr) int…
Tcl_NewDictObj, Tcl_DictObjPut, Tcl_DictObjGet, Tcl_DictObjRemove, Tcl_DictObjSize, Tcl_DictObjFirst, Tcl_DictObjNext, Tcl_DictObjDone, Tcl_DictObjPutKeyList, Tcl_DictObjRemoveKeyList – manipulate Tcl objects as dictionaries Synopsis #include <tcl.h> Tcl_Obj * Tcl_NewDictObj() int Tcl_DictObjGet(interp, dictPtr, keyPtr, valuePtrPtr) int Tcl_DictObjPut(interp, dictPtr, keyPtr, valuePtr) int Tcl_DictObjRemove(interp, dictPtr, keyPtr) int Tcl_DictObjSize(interp, dictPtr, sizePtr) int Tcl_DictObjFirst(interp, dictPtr, searchPtr, keyPtrPtr, valuePtrPtr, donePtr) void Tcl_DictObjNext(searchPtr, keyPtrPtr, valuePtrPtr, donePtr) void Tcl_DictObjDone(searchPtr) int…
Tcl_NewDictObj, Tcl_DictObjPut, Tcl_DictObjGet, Tcl_DictObjRemove, Tcl_DictObjSize, Tcl_DictObjFirst, Tcl_DictObjNext, Tcl_DictObjDone, Tcl_DictObjPutKeyList, Tcl_DictObjRemoveKeyList – manipulate Tcl objects as dictionaries Synopsis #include <tcl.h> Tcl_Obj * Tcl_NewDictObj() int Tcl_DictObjGet(interp, dictPtr, keyPtr, valuePtrPtr) int Tcl_DictObjPut(interp, dictPtr, keyPtr, valuePtr) int Tcl_DictObjRemove(interp, dictPtr, keyPtr) int Tcl_DictObjSize(interp, dictPtr, sizePtr) int Tcl_DictObjFirst(interp, dictPtr, searchPtr, keyPtrPtr, valuePtrPtr, donePtr) void Tcl_DictObjNext(searchPtr, keyPtrPtr, valuePtrPtr, donePtr) void Tcl_DictObjDone(searchPtr) int…
Tcl_NewDictObj, Tcl_DictObjPut, Tcl_DictObjGet, Tcl_DictObjRemove, Tcl_DictObjSize, Tcl_DictObjFirst, Tcl_DictObjNext, Tcl_DictObjDone, Tcl_DictObjPutKeyList, Tcl_DictObjRemoveKeyList – manipulate Tcl objects as dictionaries Synopsis #include <tcl.h> Tcl_Obj * Tcl_NewDictObj() int Tcl_DictObjGet(interp, dictPtr, keyPtr, valuePtrPtr) int Tcl_DictObjPut(interp, dictPtr, keyPtr, valuePtr) int Tcl_DictObjRemove(interp, dictPtr, keyPtr) int Tcl_DictObjSize(interp, dictPtr, sizePtr) int Tcl_DictObjFirst(interp, dictPtr, searchPtr, keyPtrPtr, valuePtrPtr, donePtr) void Tcl_DictObjNext(searchPtr, keyPtrPtr, valuePtrPtr, donePtr) void Tcl_DictObjDone(searchPtr) int…
Tcl_NewDictObj, Tcl_DictObjPut, Tcl_DictObjGet, Tcl_DictObjRemove, Tcl_DictObjSize, Tcl_DictObjFirst, Tcl_DictObjNext, Tcl_DictObjDone, Tcl_DictObjPutKeyList, Tcl_DictObjRemoveKeyList – manipulate Tcl objects as dictionaries Synopsis #include <tcl.h> Tcl_Obj * Tcl_NewDictObj() int Tcl_DictObjGet(interp, dictPtr, keyPtr, valuePtrPtr) int Tcl_DictObjPut(interp, dictPtr, keyPtr, valuePtr) int Tcl_DictObjRemove(interp, dictPtr, keyPtr) int Tcl_DictObjSize(interp, dictPtr, sizePtr) int Tcl_DictObjFirst(interp, dictPtr, searchPtr, keyPtrPtr, valuePtrPtr, donePtr) void Tcl_DictObjNext(searchPtr, keyPtrPtr, valuePtrPtr, donePtr) void Tcl_DictObjDone(searchPtr) int…
Tcl_NewDictObj, Tcl_DictObjPut, Tcl_DictObjGet, Tcl_DictObjRemove, Tcl_DictObjSize, Tcl_DictObjFirst, Tcl_DictObjNext, Tcl_DictObjDone, Tcl_DictObjPutKeyList, Tcl_DictObjRemoveKeyList – manipulate Tcl objects as dictionaries Synopsis #include <tcl.h> Tcl_Obj * Tcl_NewDictObj() int Tcl_DictObjGet(interp, dictPtr, keyPtr, valuePtrPtr) int Tcl_DictObjPut(interp, dictPtr, keyPtr, valuePtr) int Tcl_DictObjRemove(interp, dictPtr, keyPtr) int Tcl_DictObjSize(interp, dictPtr, sizePtr) int Tcl_DictObjFirst(interp, dictPtr, searchPtr, keyPtrPtr, valuePtrPtr, donePtr) void Tcl_DictObjNext(searchPtr, keyPtrPtr, valuePtrPtr, donePtr) void Tcl_DictObjDone(searchPtr) int…
Tcl_NewDictObj, Tcl_DictObjPut, Tcl_DictObjGet, Tcl_DictObjRemove, Tcl_DictObjSize, Tcl_DictObjFirst, Tcl_DictObjNext, Tcl_DictObjDone, Tcl_DictObjPutKeyList, Tcl_DictObjRemoveKeyList – manipulate Tcl objects as dictionaries Synopsis #include <tcl.h> Tcl_Obj * Tcl_NewDictObj() int Tcl_DictObjGet(interp, dictPtr, keyPtr, valuePtrPtr) int Tcl_DictObjPut(interp, dictPtr, keyPtr, valuePtr) int Tcl_DictObjRemove(interp, dictPtr, keyPtr) int Tcl_DictObjSize(interp, dictPtr, sizePtr) int Tcl_DictObjFirst(interp, dictPtr, searchPtr, keyPtrPtr, valuePtrPtr, donePtr) void Tcl_DictObjNext(searchPtr, keyPtrPtr, valuePtrPtr, donePtr) void Tcl_DictObjDone(searchPtr) int…
Tcl_NewDictObj, Tcl_DictObjPut, Tcl_DictObjGet, Tcl_DictObjRemove, Tcl_DictObjSize, Tcl_DictObjFirst, Tcl_DictObjNext, Tcl_DictObjDone, Tcl_DictObjPutKeyList, Tcl_DictObjRemoveKeyList – manipulate Tcl objects as dictionaries Synopsis #include <tcl.h> Tcl_Obj * Tcl_NewDictObj() int Tcl_DictObjGet(interp, dictPtr, keyPtr, valuePtrPtr) int Tcl_DictObjPut(interp, dictPtr, keyPtr, valuePtr) int Tcl_DictObjRemove(interp, dictPtr, keyPtr) int Tcl_DictObjSize(interp, dictPtr, sizePtr) int Tcl_DictObjFirst(interp, dictPtr, searchPtr, keyPtrPtr, valuePtrPtr, donePtr) void Tcl_DictObjNext(searchPtr, keyPtrPtr, valuePtrPtr, donePtr) void Tcl_DictObjDone(searchPtr) int…
Tcl_NewDictObj, Tcl_DictObjPut, Tcl_DictObjGet, Tcl_DictObjRemove, Tcl_DictObjSize, Tcl_DictObjFirst, Tcl_DictObjNext, Tcl_DictObjDone, Tcl_DictObjPutKeyList, Tcl_DictObjRemoveKeyList – manipulate Tcl objects as dictionaries Synopsis #include <tcl.h> Tcl_Obj * Tcl_NewDictObj() int Tcl_DictObjGet(interp, dictPtr, keyPtr, valuePtrPtr) int Tcl_DictObjPut(interp, dictPtr, keyPtr, valuePtr) int Tcl_DictObjRemove(interp, dictPtr, keyPtr) int Tcl_DictObjSize(interp, dictPtr, sizePtr) int Tcl_DictObjFirst(interp, dictPtr, searchPtr, keyPtrPtr, valuePtrPtr, donePtr) void Tcl_DictObjNext(searchPtr, keyPtrPtr, valuePtrPtr, donePtr) void Tcl_DictObjDone(searchPtr) int…
Tcl_DetachPids, Tcl_ReapDetachedProcs, Tcl_WaitPid – manage child processes in background Synopsis #include <tcl.h> Tcl_DetachPids(numPids, pidPtr) Tcl_ReapDetachedProcs() Tcl_Pid Tcl_WaitPid(pid, statusPtr, options) Arguments int numPids (in) Number of process ids contained in the array pointed to by pidPtr. int *pidPtr (in) Address of array containing numPids process ids. Tcl_Pid pid (in) The id of the process (pipe) to…
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,…