Ivi_GetConfigStoreHandle
Usage
ViStatus Ivi_GetConfigStoreHandle(IviConfigStoreHandle* handle);
Purpose
Returns a handle to the IVI Configuration Server instance currently in use by the IVI engine. You can use this handle with the IVI Foundation-defined Configuration Server C API to add or delete runtime configuration elements.
 |
Note Any changes you make to the Configuration Server through this handle are not saved, unless you explicitly save them through the Configuration Server C API. If the Configuration Store file is modified by another process or IVI Configuration Server instance, the handle returned by this function becomes invalid, and you should not use the handle. Exception: This does not apply if you specified the handle using the Ivi_AttachToConfigStoreHandle. |
Parameters
| Name | Type | Description |
|---|---|---|
| handle | IviConfigStoreHandle* | Returns a handle to the configuration server instance currently in use by the IVI engine. You can use this handle with the IVI Foundation-defined Configuration Server C API to add or delete runtime configuration elements. |
Return Value
Contains the status code that the function call returns. IVI engine functions can return error and warning values from several sets of status codes. Some status codes are unique to the IVI engine. Other status codes are the same codes that VISA Library functions return. Still others are error or warning values that functions in specific instrument drivers return. Each set of status codes has its own numeric range.
Regardless of the source of the status code, 0 always indicates success, a positive value indicates a warning, and a negative value indicates an error.