Class CDLL

constructor

• new CDLL(path: string, options?: number | LibraryOptions): CDLL

  Parameters

  • path: string

    Path to the shared library, or null to load the current process

  • Optionaloptions: number | LibraryOptions

    dlopen mode (as Python's CDLL(name, mode)) or library settings (mode, cache size, use_last_error, use_errno)

  Returns CDLL

Readonlypath

Readonlyloaded

func

• func<TRet extends FFIType, const TArgs extends readonly FFIType[]>(
      name: string,
      returnType: TRet,
      argTypes: TArgs,
      options?: FunctionOptions,
  ): TypedFFIFunction<TArgs, TRet>

  Typed overload: narrows args/return when argTypes is a literal tuple.

  Type Parameters

  • TRet extends FFIType
  • const TArgs extends readonly FFIType[]

  Parameters

  • name: string
  • returnType: TRet
  • argTypes: TArgs
  • Optionaloptions: FunctionOptions

  Returns TypedFFIFunction<TArgs, TRet>

• func(
      name: string,
  ): TypedFFIFunction<readonly FFIType[], SimpleCDataConstructor<"int32">>

  Typed overload: narrows args/return when argTypes is a literal tuple.

  Parameters

  • name: string

  Returns TypedFFIFunction<readonly FFIType[], SimpleCDataConstructor<"int32">>

• func(
      name: string,
      returnType: FFIType,
      argTypes?: FFIType[],
      options?: FunctionOptions,
  ): FFIFunction

  Typed overload: narrows args/return when argTypes is a literal tuple.

  Parameters

  • name: string
  • returnType: FFIType
  • OptionalargTypes: FFIType[]
  • Optionaloptions: FunctionOptions

  Returns FFIFunction

symbol

• symbol(name: string): bigint

  Get the address of a symbol.

  Parameters

  • name: string

    Symbol name

  Returns bigint

  Address as BigInt

close

• close(): void

  Close the library and clear the function cache. Functions obtained from it throw when called afterwards. Throws while a call to one of its functions is in progress (from a callback, or a pending callAsync()). Existing in_dll() views defer native handle release until their dependent memory is collected, but new calls and symbol lookups are rejected. Physical unloading depends on the OS loader; musl keeps modules resident.

  Returns void

[dispose]

• "[dispose]"(): void

  Close the library at the end of a using block.

  Returns void

callback

• callback<
      TRet extends CallbackRestype,
      const TArgs extends readonly FFIType[] = readonly [],
  >(
      fn: (...args: CallbackArgs<TArgs>) => CallbackResult<TRet>,
      returnType: TRet,
      argTypes?: TArgs,
  ): Callback

  Create a native callback bound to this library's context. Call release() when it is no longer needed.

  Type Parameters

  • TRet extends CallbackRestype
  • const TArgs extends readonly FFIType[] = readonly []

  Parameters

  • fn: (...args: CallbackArgs<TArgs>) => CallbackResult<TRet>
  • returnType: TRet
  • OptionalargTypes: TArgs

  Returns Callback

get_last_error

• get_last_error(): number

  Read the snapshotted GetLastError() (Windows) or errno from the most recent call on this library. Requires use_last_error: true at construction.

  Python ctypes parity: ctypes.get_last_error() (library-scoped variant).

  Returns number

get_errno

• get_errno(): number

  Read the snapshotted errno from the most recent call on this library. Requires use_errno: true at construction.

  Python ctypes parity: ctypes.get_errno() (library-scoped variant).

  Returns number