NI System Configuration API Reference for LabWindows™/CVI™

NISysCfgCreateComponentsEnum

  • Updated2023-02-21
  • 1 minute(s) read

NISysCfgStatus NISysCfgCreateComponentsEnum(NISysCfgEnumSoftwareComponentHandle * componentEnumHandle);

Purpose

Creates a list of software components, along with NISysCfgAddComponentToEnum, that can then be passed into NISysCfgInstallUninstallComponents or NISysCfgInstallSoftwareSet.

Parameters

Output
Name Type Description
componentEnumHandle NISysCfgEnumSoftwareComponentHandle * Creates a handle to a software component enum that can be populated using NISysCfgAddComponentToEnum.

When it is no longer needed, this handle must be discarded using NISysCfgCloseHandle.

Return Value

Name Type Description
returnValue NISysCfgStatus The error code returned by the function in the event of an error or warning. A value of 0 indicates success. A positive value indicates a warning. A negative value indicates an error. Refer to Status Codes or nisyscfg_errors.h for details regarding error codes.