NISysCfgNextComponentInfo

NI System Configuration 18.0 Function Reference for LabWindows/CVI

Edition Date: May 2018

Part Number: 373242M-01

»View Product Info
Download Help (Windows Only)

NISysCfgStatus NISysCfgNextComponentInfo( NISysCfgEnumSoftwareComponentHandle componentEnumHandle, char ID[], char version[], char title[], NISysCfgComponentType * itemType, char ** detailedDescription );

Purpose

Returns detailed information about the next component in the supplied componentEnumHandle.

Parameters

Input
Name Type Description
componentEnumHandle NISysCfgEnumSoftwareComponentHandle A handle to a list of software components on a system returned by NISysCfgGetInstalledSoftwareComponents, NISysCfgInstallAll or NISysCfgGetSoftwareSetInfo.
Output
Name Type Description
ID char [] The ID of the component.

You must pass a string buffer at least size NISYSCFG_SIMPLE_STRING_LENGTH, which is defined in nisyscfg.h.
version char [] The version of the component.

You must pass a string buffer at least size NISYSCFG_SIMPLE_STRING_LENGTH, which is defined in nisyscfg.h.
title char [] The name of the component.

You must pass a string buffer at least size NISYSCFG_SIMPLE_STRING_LENGTH, which is defined in nisyscfg.h.
itemType NISysCfgIncludeComponentType * The component type. This is NISysCfgItemTypeStandard by default.
detailedDescription char ** Returns a detailed description of the component. You must free detailedDescription using NISysCfgFreeDetailedString.

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.

WAS THIS ARTICLE HELPFUL?

Not Helpful