ntapi.h

Initializes the NTAPI library.

This function must be called prior to any other NTAPI function. It will initialize the NTAPI library and perform compatibility checks based on the version applied. The version is used to indicate to NTAPI what version of the API the application supports and will enable NTAPI to act on this and adapt to that version of the API if possible. This means that if the application is compiled to e.g. version 1 of the API and the current API is version 9, NT_Init will check if it is possible to enable backward compatibility to version 1 and thereby allow the application to run on a version 9 library with version 1 API.

Parameters

[in]

version

The version that the calling application supports

Return values

NT_SUCCESS	Success
!=0	Error

Examples:

bypass/config/bypass_config_example.c, bypass/info/bypass_info_example.c, bypass/watchdog/bypass_watchdog_example.c, config/config_example.c, event/event_example.c, eventMonitor_example.c, flowmatch/flowmatch_example_main.cpp, info/info_example.c, net/analysis/analysis_example.c, net/capture/capture_example.c, net/checksum/checksum_example.cpp, net/inline/inline_example.c, net/ipfdemo/ipfdemo_example.c, net/netflow/netflow_example.c, net/numa/numa_example.c, net/readcapfile/readcapfile_example.c, net/replay/replay_example.c, net/replay4GA/replay4ga_example.c, net/replayGS/replayGS_example.c, net/streamidstatistics/streamidstatistics_example.c, net/timestamp_inject/timestamp_inject_example.cpp, net/transmit_multifunction/transmit_multifunction_example.c, net/transmit_on_timestamp/transmit_on_timestamp_example.c, net/transmit_on_timestamp_setclock/transmit_on_timestamp_setclock_example.c, net/transmit_packet/transmit_packet_example.c, net/transmit_pcap/transmit_pcap_example.c, net/transmit_segment/transmit_segment_example.c, net/transmit_segment_dyn_descr/transmit_segment_dyn_descr_example.cpp, net/vlandemo/vlandemo_example.c, pps/pps_example.c, sensor/sensor_example.c, stat/stat_example.c, and statUsage/statUsage_example.c.

Referenced by main().

Closes down the NTAPI library.

Return values

NT_SUCCESS

Success

Examples:

bypass/config/bypass_config_example.c, bypass/info/bypass_info_example.c, bypass/watchdog/bypass_watchdog_example.c, config/config_example.c, event/event_example.c, eventMonitor_example.c, flowmatch/flowmatch_example_main.cpp, info/info_example.c, net/analysis/analysis_example.c, net/capture/capture_example.c, net/checksum/checksum_example.cpp, net/numa/numa_example.c, net/streamidstatistics/streamidstatistics_example.c, net/timestamp_inject/timestamp_inject_example.cpp, net/transmit_multifunction/transmit_multifunction_example.c, net/transmit_on_timestamp/transmit_on_timestamp_example.c, net/transmit_on_timestamp_setclock/transmit_on_timestamp_setclock_example.c, net/transmit_packet/transmit_packet_example.c, net/transmit_pcap/transmit_pcap_example.c, net/transmit_segment/transmit_segment_example.c, net/transmit_segment_dyn_descr/transmit_segment_dyn_descr_example.cpp, net/vlandemo/vlandemo_example.c, sensor/sensor_example.c, stat/stat_example.c, and statUsage/statUsage_example.c.

Referenced by main().

Explains an error code returned by NTAPI functions.

This function will convert the error code to text

Parameters

[in]	error	The error code to explain
[in,out]	buf	Location of the explanation
[in]	buflen	The buffer length to prevent buffer overrun. The define NT_ERRBUF_SIZE should be used as buflen.

Return values

A	pointer to buf

Examples:

bypass/config/bypass_config_example.c, bypass/info/bypass_info_example.c, bypass/watchdog/bypass_watchdog_example.c, config/config_example.c, event/event_example.c, eventMonitor_example.c, info/info_example.c, net/analysis/analysis_example.c, net/capture/capture_example.c, net/checksum/checksum_example.cpp, net/inline/inline_example.c, net/ipfdemo/ipfdemo_example.c, net/netflow/netflow_example.c, net/numa/numa_example.c, net/readcapfile/readcapfile_example.c, net/replay/replay_example.c, net/replay4GA/replay4ga_example.c, net/replayGS/replayGS_example.c, net/streamidstatistics/streamidstatistics_example.c, net/timestamp_inject/timestamp_inject_example.cpp, net/transmit_multifunction/transmit_multifunction_example.c, net/transmit_on_timestamp/transmit_on_timestamp_example.c, net/transmit_on_timestamp_setclock/transmit_on_timestamp_setclock_example.c, net/transmit_packet/transmit_packet_example.c, net/transmit_pcap/transmit_pcap_example.c, net/transmit_segment/transmit_segment_example.c, net/transmit_segment_dyn_descr/transmit_segment_dyn_descr_example.cpp, net/vlandemo/vlandemo_example.c, pps/pps_example.c, sensor/sensor_example.c, stat/stat_example.c, and statUsage/statUsage_example.c.

Referenced by _NetTxDataCheckHbInfo(), _TxPortRateLimit(), featuresAvailable(), ForceAnEvent(), GetAdapterTimestamp(), GetSensorData(), GetTimeStamp(), handle_error_status(), handleErrorStatus(), if(), Is4GATxSupported(), main(), printError(), PacketReaderThread::processPackets(), SetGlobalSync(), PacketTransmitterThread::transmitPackets(), PacketTransmitterThread::txPacket(), and while().