DioFileGetLoadOptions

Applies To

File.

Purpose

Returns the specified file load options.

Syntax

DioFileGetLoadOptions (hFile, pdwFileLoadOptions, pnStatus)

Parameters

Name
Type
Comments
hFile
SHORT
File board handle returned by the function DioFileOpen.
pdwFileLoadOptions
PDWORD
File load options:
0. DIO_FILE_LOAD_ALL_DOMAIN_RESET_ON_FILE_LOAD: default settings, in this mode all the data and settings will be loaded and applied to the hardware. As well as reset the domain.
1. DIO_FILE_NO_DOMAIN_RESET_ON_FILE_LOAD: setting this flag will not reset all the boards in the domain before loading the new settings from the DIO file (default is to always reset the domain). This may be used to prevent I/O levels to change when loading consecutive vector files.
2. DIO_FILE_LOAD_DATA_ONLY: settings this flag will only load the file data to the boards’ in the domain.
4. DIO_FILE_LOAD_SETTINGS_ONLY: settings this flag will only load the file settings to the boards’ in the domain.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Example

The following example returns the load data only flag:

 

SHORT nStatus, hFile;

DWORD dwFileLoadOptions;

DioFileOpen (szfilename, 1, &hFile, &nStatus);

if (hFile!=0 && nStatus==0)

DioFileGetLoadOptions (hFile, &dwFileLoadOptions, &nStatus);

 

See Also

DioFileSetLoadOptions, DioGetErrorString