Index

  • Type the index terms you want to search for in the text input field.
  • Matching terms will be shown incrementally as you type.
  • Press Enter to navigate to the target of the first displayed index entry.
  • Alternatively, Tab to move to the index entry of interest and then press Enter to navigate to that documentation page.
  • To jump to this page from any other documentation page, press browser-specific shortcut modifiers with i. For example, on IE and Edge this would be Alt-i while on Firefox and Chrome Alt-Shift-i. Other browsers and platforms may differ.
  • addressofReturns the address of a symbol from the loaded library. ::cffi::dyncall::Library
  • alias bodyReturns the resolved body of an alias. ::cffi
  • alias defineDefines a type alias ::cffi
  • alias deleteDeletes type aliases matching a pattern. ::cffi
  • alias listReturns a list of aliases matching the specified pattern. ::cffi
  • alias loadLoads predefined type aliases. ::cffi
  • allocateAllocates memory for one or more C structs. ::cffi::Struct
  • ataddressReturns the name of the symbol at a specified address. ::cffi::dyncall::Symbols
  • callInvokes a C function through a function pointer. ::cffi
  • constructorConstructs a script level object that maps to a C struct definition. ::cffi::Struct
  • constructorWraps a shared library / DLL, loading it in the process. ::cffi::dyncall::Library
  • constructorWraps a shared library / DLL to allow access to its symbols. ::cffi::dyncall::Symbols
  • countReturns the number of symbols defined in the library. ::cffi::dyncall::Symbols
  • describeReturns a human-readable description of the C struct definition. ::cffi::Struct
  • destructorDestroys the object and releases internal resources. ::cffi::dyncall::Library
  • destructorDestroys the object. ::cffi::dyncall::Symbols
  • enum defineDefines a new enumeration. ::cffi
  • enum deleteDeletes enumerations. ::cffi
  • enum listLists enumerations. ::cffi
  • enum membersReturns a dictionary containing the definitions in an enumerations. ::cffi
  • enum nameReturns the symbolic name of a value in an enumeration ::cffi
  • enum sequenceDefines an enumeration with consecutive member values ::cffi
  • enum valueReturns the value of an enumeration member ::cffi
  • freeFrees memory that was allocated for a native C struct. ::cffi::Struct
  • frombinaryDecodes a Tcl binary string containing a native C struct into a Tcl dictionary. ::cffi::Struct
  • fromnativeDecodes native C struct(s) in memory into a Tcl dictionary. ::cffi::Struct
  • functionCreates a Tcl command to invoke a C function in the loaded library. ::cffi::dyncall::Library
  • functionsCreates Tcl commands for multiple C functions within the loaded library. ::cffi::dyncall::Library
  • help functionReturns a string describing the syntax for a CFFI wrapped function ::cffi
  • help functionsReturns a list of CFFI-wrapped functions matching the pattern FUNCPATTERN ::cffi
  • indexReturns the name of the symbol at a specified index. ::cffi::dyncall::Symbols
  • infoReturns a dictionary containing information about the struct layout ::cffi::Struct
  • Library ::cffi::dyncall
  • memory allocateAllocates memory of the specified size ::cffi
  • memory freeFrees the memory referenced by the passed pointer ::cffi
  • memory frombinaryAllocates memory and copied the passed Tcl binary string into it. ::cffi
  • memory fromstringAllocates memory and stores a Tcl string in it in the specified encoding. ::cffi
  • memory setSets the memory locations to a specified value ::cffi
  • memory tobinaryReturns the content of a memory block as a Tcl binary string. ::cffi
  • memory tobinary!Returns the content of a memory block as a Tcl binary string. ::cffi
  • memory tostringReturns the content of a memory block as a Tcl string. ::cffi
  • memory tostring!Returns the content of a memory block as a Tcl string. ::cffi
  • nameReturns the name of the struct. ::cffi::Struct
  • pathReturns the file system path for the wrapped library or image wrapped by the object. ::cffi::dyncall::Library
  • pointer addressReturns the address component of the pointer. ::cffi
  • pointer checkValidates a pointer and raise an exception if invalid. ::cffi
  • pointer countedRegisters a pointer as a counted pointer ::cffi
  • pointer disposeUnregisters a safe or counted pointer ::cffi
  • pointer isnullReturns true if the pointer is a NULL pointer, false otherwise. ::cffi
  • pointer isvalidValidates a pointer. ::cffi
  • pointer listReturns a list of registered pointers optionally filtered by a tag. ::cffi
  • pointer safeRegisters a pointer as a safe uncounted pointer ::cffi
  • pointer tagReturns the pointer tag ::cffi
  • prototype deleteDeletes prototypes matching a pattern. ::cffi
  • prototype functionDefines a function prototype for calling a function using the default C calling convention. ::cffi
  • prototype listReturns a list of prototypes matching the specified pattern. ::cffi
  • prototype stdcallDefines a function prototype for calling a function using the stdcall calling convention. ::cffi
  • stdcallCreates a Tcl command to invoke a C function that uses the __stdcall calling convention from the loaded library.. ::cffi::dyncall::Library
  • stdcallsCreates Tcl commands for multiple C functions within the loaded library that all use the __stdcall calling convention. ::cffi::dyncall::Library
  • Struct ::cffi
  • Symbols ::cffi::dyncall
  • tobinaryEncodes the Tcl representation of a C struct value into a Tcl binary string. ::cffi::Struct
  • tonativeWrites the Tcl dictionary representation of a C struc value to memory in native form. ::cffi::Struct
  • type countReturns the count of elements in an array type ::cffi
  • type infoReturns a dictionary containing various information about a type declaration ::cffi
  • type sizeReturns the size of a type in terms of the number of bytes of memory occupied by that type. ::cffi
Document generated by Ruff!