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.

addressof
```
WRAPPEROBJ addressof symbol
```
Returns the address of a symbol from the loaded library.
::cffi::Wrapper
alias
```
alias subcommand ...
```
A command ensemble.
::cffi
alias body
```
alias body alias_name
```
Returns the resolved body of an alias.
::cffi
alias clear
```
alias clear 
```
Deletes all aliases from the interpreter
::cffi

alias define name definition
alias define aliasdefs

Defines one or more type aliases. ::cffi

alias delete
```
alias delete pattern
```
Deletes aliases matching a pattern.
::cffi
alias list
```
alias list ?pattern?
```
Returns a list of aliases that match the specified pattern.
::cffi
alias load
```
alias load alias_set
```
Loads predefined type aliases.
::cffi
allocate
```
STRUCTOBJ allocate ?args?
```
Allocates memory for one or more C structs.
::cffi::Struct
arena
```
arena subcommand ...
```
A command ensemble.
::cffi
arena allocate
```
arena allocate sizespec ?tag?
```
Allocates memory in the current arena frame in the memory arena.
::cffi
arena new
```
arena new typespec initializer ?tag?
```
Allocates memory in the current arena for a type and initializes it.
::cffi
arena popframe
```
arena popframe 
```
Pops the current frame from the memory arena.
::cffi
arena pushframe
```
arena pushframe ?size?
arena pushframe size ?tag?
```
Pushes a new stack frame on the memory arena.
::cffi
call
```
call fnptr ?args?
```
Invokes a C function through a function pointer.
::cffi
callback
```
callback subcommand ...
```
A command ensemble.
::cffi
callback free
```
callback free cb
```
Frees a callback pointer
::cffi
callback new
```
callback new protoname cmdprefix error_value
```
Wraps a script level command into a C function
::cffi
constructor
```
Interface create OBJNAME ?args?
Interface new ?args?
```
Defines an interface consisting of method definitions.
::cffi::Interface
constructor
```
Struct create OBJNAME definition ?args?
Struct new definition ?args?
```
Constructs a script level object that maps to a C struct definition.
::cffi::Struct
constructor
```
Union create OBJNAME definition ?args?
Union new definition ?args?
```
Constructs a script level object that maps to a C union definition.
::cffi::Union
constructor
```
Wrapper create OBJNAME path
Wrapper new path
```
Wraps a shared library / DLL, loading it in the process.
::cffi::Wrapper
decode
```
UNIONOBJ decode field uvalue
```
Returns a field from a native union.
::cffi::Union
describe
```
STRUCTOBJ describe 
```
Returns a human-readable description of the C struct definition.
::cffi::Struct
describe
```
UNIONOBJ describe 
```
Returns a human-readable description of the C union definition.
::cffi::Union
destructor
```
WRAPPEROBJ destroy 
```
Destroys the object and releases internal resources.
::cffi::Wrapper
encode
```
UNIONOBJ encode field value
```
Returns a union in native form with the specified field value.
::cffi::Union
enum
```
enum subcommand ...
```
A command ensemble.
::cffi
enum alias
```
enum alias enumname enumdefs typedecl
```
Defines a new enumeration and alias of the same name
::cffi
enum clear
```
enum clear 
```
Deletes all enumerations from the interpreter
::cffi
enum define
```
enum define enumname enumdefs
```
Defines a new enumeration.
::cffi
enum delete
```
enum delete pattern
```
Deletes enumerations.
::cffi
enum flags
```
enum flags enumname membernames
```
Defines an enumeration as bit flags.
::cffi
enum list
```
enum list pattern
```
Lists enumerations.
::cffi
enum mask
```
enum mask enumname membernames
```
Returns an integer mask formed by bitwise OR-ing the passed enumeration members
::cffi
enum members
```
enum members enumname
```
Returns a dictionary containing the members in an enumeration.
::cffi
enum name
```
enum name enumname membervalue ?default?
```
Returns the symbolic name of a value in an enumeration.
::cffi
enum names
```
enum names enumname
```
Returns a list containing the names of members in an enumeration.
::cffi
enum sequence
```
enum sequence enumname membernames ?start?
```
Defines an enumeration with consecutive member values
::cffi
enum unmask
```
enum unmask enumname mask
```
Returns a list of enumeration member names corresponding to the bits set in $mask.
::cffi
enum value
```
enum value enumname membername ?default?
```
Returns the value of an enumeration member
::cffi
fieldpointer
```
STRUCTOBJ fieldpointer pointer fieldname ?tag? ?index?
```
Returns a pointer corresponding to the address of a field within a native structure
::cffi::Struct
free
```
STRUCTOBJ free pointer
```
Frees memory that was allocated for a native C struct.
::cffi::Struct
frombinary
```
STRUCTOBJ frombinary bin_value
```
Decodes a Tcl binary string containing a native C struct into a Tcl dictionary.
::cffi::Struct
fromnative
```
STRUCTOBJ fromnative pointer ?index?
```
Decodes native C struct(s) in memory into a Tcl dictionary.
::cffi::Struct
fromnative!
```
STRUCTOBJ fromnative! pointer ?index?
```
Decodes native C struct(s) in memory into a Tcl dictionary.
::cffi::Struct
function
```
WRAPPEROBJ function fnname fntype parameters
```
Creates a Tcl command to invoke a C function in the loaded library.
::cffi::Wrapper
functions
```
WRAPPEROBJ functions fnlist ?args?
```
Creates Tcl commands for multiple C functions within the loaded library.
::cffi::Wrapper
getnative
```
STRUCTOBJ getnative pointer fieldname ?index?
```
Returns the value of a field in a native structure in memory
::cffi::Struct
getnative!
```
STRUCTOBJ getnative! pointer fieldname ?index?
```
Returns the value of a field in a native structure in memory
::cffi::Struct
getnativefields
```
STRUCTOBJ getnativefields pointer fieldnames ?index?
```
Retrieve values of multiple fields from a native struct in memory.
::cffi::Struct
getnativefields!
```
STRUCTOBJ getnativefields! pointer fieldnames ?index?
```
Retrieve values of multiple fields from a native struct in memory.
::cffi::Struct
help
```
help subcommand ...
```
A command ensemble.
::cffi
help alias
```
help alias NAME
```
Returns a string describing an alias definition.
::cffi
help enum
```
help enum NAME
```
Returns a string describing an enum definition.
::cffi
help function
```
help function NAME
```
Returns a string describing the syntax and parameter definitions for a CFFI wrapped function.
::cffi
help functions
```
help functions ?PATTERN?
```
Returns a list of CFFI-wrapped functions matching the pattern PATTERN.
::cffi
help struct
```
help struct NAME
```
Returns a string describing field types in a Struct.
::cffi
help union
```
help union NAME
```
Returns a string describing field types in a Union.
::cffi
id
```
INTERFACEOBJ id 
```
Returns the id for the interface as passed via the -id option in the interface definition.
::cffi::Interface
info
```
STRUCTOBJ info ?args?
```
Returns a dictionary containing information about the struct layout
::cffi::Struct
info
```
UNIONOBJ info 
```
Returns a dictionary containing information about the info layout
::cffi::Union
Interface ::cffi
limits
```
limits type
```
Get the lower and upper limits for an integral base type
::cffi
memory
```
memory subcommand ...
```
A command ensemble.
::cffi
memory allocate
```
memory allocate sizespec ?tag?
```
Allocates memory of the specified size
::cffi
memory fill
```
memory fill pointer bytevalue count ?offset?
```
Fills memory with a specified value
::cffi
memory free
```
memory free pointer
```
Frees the memory referenced by the passed pointer
::cffi
memory frombinary
```
memory frombinary bin_value ?tag?
```
Allocates memory and copied the passed Tcl binary string into it.
::cffi
memory fromstring
```
memory fromstring value ?encoding?
```
Allocates memory and stores a Tcl string in it in the specified encoding.
::cffi
memory fromunistring
```
memory fromunistring value
```
Allocates memory and stores a Tcl string as a sequence of Tcl_UniChars.
::cffi
memory fromwinstring
```
memory fromwinstring value
```
Allocates memory and stores a Tcl string as a sequence of winchars.
::cffi
memory get
```
memory get pointer typespec ?index?
```
Converts a native value in memory into a Tcl script level value
::cffi
memory get!
```
memory get! pointer typespec ?index?
```
Converts a native value in memory into a Tcl script level value
::cffi
memory new
```
memory new typespec initializer ?tag?
```
Allocates memory for a type and initializes it.
::cffi
memory set
```
memory set pointer typespec value ?index?
```
Converts a value as per a type specification and stores it in memory in native form
::cffi
memory set!
```
memory set! pointer typespec value ?index?
```
Converts a value as per a type specification and stores it in memory in native form
::cffi
memory tobinary
```
memory tobinary pointer size ?offset?
```
Returns the content of a memory block as a Tcl binary string.
::cffi
memory tobinary!
```
memory tobinary! pointer size ?offset?
```
Returns the content of a memory block as a Tcl binary string.
::cffi
memory tostring
```
memory tostring pointer ?encoding? ?offset?
```
Returns the content of a memory block as a Tcl string.
::cffi
memory tostring!
```
memory tostring! pointer ?encoding? ?offset?
```
Returns the content of a memory block as a Tcl string.
::cffi
memory tounistring
```
memory tounistring pointer ?offset?
```
Returns the content of a memory block containing a nul-terminated sequence of Tcl_UniChars as a Tcl string.
::cffi
memory tounistring!
```
memory tounistring! pointer ?offset?
```
Returns the content of a memory block containing a nul-terminated sequence of Tcl_UniChars as a Tcl string.
::cffi
memory towinstring
```
memory towinstring pointer ?offset?
```
Returns the content of a memory block containing a nul-terminated sequence of winchars as a Tcl string.
::cffi
memory towinstring!
```
memory towinstring! pointer ?offset?
```
Returns the content of a memory block containing a nul-terminated sequence of winchars as a Tcl string.
::cffi
methods
```
INTERFACEOBJ methods methodlist ?args?
```
Creates Tcl commands wrapping the C functions comprising an interface.
::cffi::Interface
name
```
STRUCTOBJ name 
```
Returns the name of the struct.
::cffi::Struct
name
```
UNIONOBJ name 
```
Returns the name of the struct.
::cffi::Union
new
```
STRUCTOBJ new ?initval?
```
Allocates and initializes a native struct in memory.
::cffi::Struct
path
```
WRAPPEROBJ path 
```
Returns the file system path for the wrapped library or image wrapped by the object.
::cffi::Wrapper
pkgconfig
```
pkgconfig subcommand ...
```
A command ensemble.
::cffi
pkgconfig get
```
pkgconfig get key
```
Gets the value of a configuration key.
::cffi
pkgconfig list
```
pkgconfig list 
```
Returns the list of keys containing information about the package configuration.
::cffi
pointer
```
pointer subcommand ...
```
A command ensemble.
::cffi
pointer address
```
pointer address pointer
```
Returns the address component of the pointer.
::cffi
pointer cast
```
pointer cast pointer ?TAG?
```
Casts a pointer to a new tag.
::cffi
pointer castable
```
pointer castable subtags supertag
```
Specifies that pointers with tag $subtag are acceptable in declarations that require $supertag.
::cffi
pointer castables
```
pointer castables 
```
Returns a list of tags that have been marked as castable with the pointer castable command..
::cffi
pointer check
```
pointer check pointer
```
Validates a pointer and raise an exception if invalid.
::cffi
pointer compare
```
pointer compare ptr1 ptr2
```
Compares if two pointers are the same
::cffi
pointer counted
```
pointer counted pointer
```
Registers a pointer as a counted pointer
::cffi
pointer dispose
```
pointer dispose pointer
```
Unregisters a safe or counted pointer
::cffi
pointer info
```
pointer info pointer
```
Returns a dictionary containing registration information about a pointer.
::cffi
pointer invalidate
```
pointer invalidate pointer
```
Unregisters a safe, counted or pinned pointer irrespective its reference count.
::cffi
pointer isnull
```
pointer isnull pointer
```
Returns true if the pointer is a NULL pointer, false otherwise.
::cffi
pointer isvalid
```
pointer isvalid pointer
```
Validates a pointer.
::cffi
pointer list
```
pointer list ?tag?
```
Returns a list of registered pointers optionally filtered by a tag.
::cffi
pointer make
```
pointer make address ?tag?
```
Return a pointer for a memory address.
::cffi
pointer pin
```
pointer pin pointer
```
Pins a pointer as permanently safe.
::cffi
pointer safe
```
pointer safe pointer
```
Registers a pointer as a safe uncounted pointer.
::cffi
pointer tag
```
pointer tag pointer
```
Returns the pointer tag
::cffi
pointer uncastable
```
pointer uncastable tag
```
Makes pointers with the specified tag uncastable to another type
::cffi
prototype
```
prototype subcommand ...
```
A command ensemble.
::cffi
prototype delete
```
prototype delete pattern
```
Deletes prototypes matching a pattern.
::cffi
prototype function
```
prototype function name fntype parameters
```
Defines a function prototype for calling a function using the default C calling convention.
::cffi
prototype list
```
prototype list ?pattern?
```
Returns a list of prototypes matching the specified pattern.
::cffi
prototype stdcall
```
prototype stdcall name fntype parameters
```
Defines a function prototype for calling a function using the stdcall calling convention.
::cffi
savederrors
```
savederrors 
```
Return errno and GetLastError() values from the last CFFI call annotated with saveerrors.
::cffi
setnative
```
STRUCTOBJ setnative pointer fieldname value ?index?
```
Sets the value of a field in a native structure in memory
::cffi::Struct
setnative!
```
STRUCTOBJ setnative! pointer fieldname value ?index?
```
Sets the value of a field in a native structure in memory
::cffi::Struct
size
```
STRUCTOBJ size ?args?
```
Returns the size of the struct.
::cffi::Struct
size
```
UNIONOBJ size 
```
Returns the size of the union.
::cffi::Union
stdcall
```
WRAPPEROBJ stdcall fnname fntype parameters
```
Creates a Tcl command to invoke a C function that uses the __stdcall calling convention from the loaded library..
::cffi::Wrapper
stdcalls
```
WRAPPEROBJ stdcalls fnlist ?args?
```
Creates Tcl commands for multiple C functions within the loaded library that all use the __stdcall calling convention.
::cffi::Wrapper
stdmethods
```
INTERFACEOBJ stdmethods methodlist ?args?
```
Creates Tcl commands corresponding to the C functions comprising an interface.
::cffi::Interface
Struct ::cffi
tobinary
```
STRUCTOBJ tobinary dict_value
```
Encodes the Tcl representation of a C struct value into a Tcl binary string.
::cffi::Struct
tonative
```
STRUCTOBJ tonative pointer initializer ?index?
```
Writes the Tcl dictionary representation of a C struct value to memory in native form.
::cffi::Struct
tonative!
```
STRUCTOBJ tonative! pointer initializer ?index?
```
Writes the Tcl dictionary representation of a C struct value to memory in native form.
::cffi::Struct
type
```
type subcommand ...
```
A command ensemble.
::cffi
type count
```
type count type
```
Returns the count of elements in an array type
::cffi
type frombinary
```
type frombinary typespec value
```
Converts the native binary value to its script level representation.
::cffi
type info
```
type info typedecl ?args?
```
Returns a dictionary containing various information about a type declaration
::cffi
type size
```
type size type ?args?
```
Returns the size of a type in terms of the number of bytes of memory occupied by that type.
::cffi
type tobinary
```
type tobinary typespec value
```
Converts a script level value to a native representation.
::cffi
Union ::cffi
Wrapper ::cffi