DioFileGetLabel

Applies To

File.

Purpose

Returns the specified step label.

Syntax

DioFileGetLabel (hFile, dwStep, pszLabel, nMaxLength, pnStatus)

Parameters

Name
Type
Comments
hFile
SHORT
File board handle returned by the function DioFileOpen.
dwStep
DWORD
Label's step
pszLabel
PSTR
Pointer to the string holding the label.
nMaxLength
SHORT
Maximum length of pszLabel.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Example

The following example returns the label at step 100:

 

SHORT nStatus, hFile;

CHAR szLabel[256];

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

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

DioFileGetLabel (hFile, 100, szLabel, 256, &nStatus);

 

See Also

DioFileSetLabel, DioFileFindLabel, DioGetErrorString