WPILibC++  2020.3.2
File Save/Load Functions

Functions

const char * nt::SavePersistent (StringRef filename)
 Save persistent values to a file. More...
 
const char * nt::SavePersistent (NT_Inst inst, const Twine &filename)
 Save persistent values to a file. More...
 
const char * nt::LoadPersistent (StringRef filename, std::function< void(size_t line, const char *msg)> warn)
 Load persistent values from a file. More...
 
const char * nt::LoadPersistent (NT_Inst inst, const Twine &filename, std::function< void(size_t line, const char *msg)> warn)
 
const char * nt::SaveEntries (NT_Inst inst, const Twine &filename, const Twine &prefix)
 Save table values to a file. More...
 
const char * nt::LoadEntries (NT_Inst inst, const Twine &filename, const Twine &prefix, std::function< void(size_t line, const char *msg)> warn)
 Load table values from a file. More...
 

Detailed Description

Function Documentation

◆ LoadEntries()

const char* nt::LoadEntries ( NT_Inst  inst,
const Twine filename,
const Twine prefix,
std::function< void(size_t line, const char *msg)>  warn 
)

Load table values from a file.

The file format used is identical to that used for SavePersistent / LoadPersistent.

Parameters
instinstance handle
filenamefilename
prefixload only keys starting with this prefix
warncallback function for warnings
Returns
error string, or nullptr if successful

◆ LoadPersistent() [1/2]

const char* nt::LoadPersistent ( NT_Inst  inst,
const Twine filename,
std::function< void(size_t line, const char *msg)>  warn 
)

Parameters
instinstance handle

◆ LoadPersistent() [2/2]

const char* nt::LoadPersistent ( StringRef  filename,
std::function< void(size_t line, const char *msg)>  warn 
)

Load persistent values from a file.

The server automatically does this at startup, but this function provides a way to restore persistent values in the same format from a file at any time on either a client or a server.

Parameters
filenamefilename
warncallback function for warnings
Returns
error string, or nullptr if successful

◆ SaveEntries()

const char* nt::SaveEntries ( NT_Inst  inst,
const Twine filename,
const Twine prefix 
)

Save table values to a file.

The file format used is identical to that used for SavePersistent.

Parameters
instinstance handle
filenamefilename
prefixsave only keys starting with this prefix
Returns
error string, or nullptr if successful

◆ SavePersistent() [1/2]

const char* nt::SavePersistent ( NT_Inst  inst,
const Twine filename 
)

Save persistent values to a file.

The server automatically does this, but this function provides a way to save persistent values in the same format to a file on either a client or a server.

Parameters
filenamefilename
Returns
error string, or nullptr if successful
Parameters
instinstance handle

◆ SavePersistent() [2/2]

const char* nt::SavePersistent ( StringRef  filename)

Save persistent values to a file.

The server automatically does this, but this function provides a way to save persistent values in the same format to a file on either a client or a server.

Parameters
filenamefilename
Returns
error string, or nullptr if successful