C++ SDK

◆ UnloadGFFile()

static int CApplicationAPI::UnloadGFFile ( LpError  lpError,
LPCTSTR  lpszPath,
DWORD  dwMaxTime = DEFAULT_MAX_TIME 
)
static

The function unloads GF file and erases all the lines drawn before. See specification of GF files here GF Files specification

Parameters
lpErrorAdditional error information returned from Drive.
lpszPathGF file full path.
dwMaxTimeMaximum time (in milliseconds) function can take. If dwMaxTime=0 function execution is not time limited.
Returns
1 if file was found and loaded, other value otherwise

Possible error codes returned from Drive are:

  • 0 - Function not succeeded.
  • 1 - Function succeeded.
  • 2 - Drive not succeeded.
  • 3 - Function reached timeout.