Helpers

class ingenialink.get_adapters_addresses.AdapterFamily(value)

An enumeration.

class ingenialink.get_adapters_addresses.ScanFlags(value)

An enumeration.

ingenialink.get_adapters_addresses.get_adapter(ifname: str, adapter_family: AdapterFamily = <AdapterFamily.UNSPEC: 0>, scan_flags: list[ScanFlags] | ScanFlags = [<ScanFlags.INCLUDE_PREFIX: 16>, <ScanFlags.INCLUDE_ALL_INTERFACES: 256>]) → CyAdapter | None

Retrieves the address of a specific adapter by its name.

Parameters:

• ifname –

  The name of the adapter to retrieve. Should match the AdapterName field in the CyAdapter structure, ex:

  AdapterName=’{129BCE68-6859-4A78-B17E-6A80054E9F98}’

• adapter_family – The address family to filter by (default is UNSPEC).

• scan_flags – Flags to control the scanning behavior (default includes prefix).

Returns:

The adapter information or None if not found.

ingenialink.get_adapters_addresses.get_adapters_addresses(adapter_families: list[AdapterFamily] | AdapterFamily = <AdapterFamily.UNSPEC: 0>, scan_flags: list[ScanFlags] | ScanFlags = <ScanFlags.INCLUDE_PREFIX: 16>) → list[CyAdapter]

Retrieves the addresses associated with the adapters on the local Windows computer.

Returns:

adapters on the local computer.