DioFileGetNumberOfBoards

Applies To

File.

Purpose

Returns number of file boards in DIO file previously opened using DioFileOpen command.

Syntax

DioFileGetNumberOfBoards (hFile, pnNumBoards, pnStatus)

Parameters

Name
Type
Comments
hFile
SHORT
File board handle returned by the function DioFileOpen.
pnNumBoards
PSHORT
Returns the number of file boards in the vector file.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Example

The following example creates a DIO file, adds a board and then returns the number of boards in the file:

 

SHORT nStatus, hFile, hFileBoard, nNumBoards;

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

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

{ DioFileInsertBoard (hFile, 1, &hFileBoard, &nStatus);

  DioFileGetNumberOfBoards(hFile, &nNumBoards, &nStatus);

  if (nNumBoards!=2)

  prints(“Error: mismatch number of boards in file”);

  return;}

}

 

See Also

DioFileSetNumberOfSteps, DioFileOpen, DioFileClose, DioFileInsertBoard