NISysCfgDeleteResource
- Updated2023-02-21
- 1 minute(s) read
NISysCfgStatus NISysCfgDeleteResource( NISysCfgResourceHandle resourceHandle, NISysCfgDeleteValidationMode mode, NISysCfgBool * dependentItemsDeleted, char ** detailedResult );
Purpose
Permanently removes a hardware resource and its configuration data from the system. Not all devices can be deleted; consult your product documentation.
Parameters
| Input | ||||||||||
| Name | Type | Description | ||||||||
| resourceHandle | NISysCfgResourceHandle | The resource object handle returned from NISysCfgFindHardware. | ||||||||
| mode | NISysCfgDeleteValidationMode |
Specifies the conditions under which to delete the specified resource.
|
||||||||
| Output | ||||||||||
| Name | Type | Description | ||||||||
| dependentItemsDeleted | NISysCfgBool * | Returns whether resources other than the specified one were deleted. For example, this may happen if the resource is a simulated chassis that contained modules. | ||||||||
| detailedResult | char ** | A string containing results of any errors that may have occurred during execution. You must call NISysCfgFreeDetailedString to free that string when you are done with it. | ||||||||
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. |