Table Functions

Functions
NT_Entry	nt::GetEntry (NT_Inst inst, std::string_view name)
	Get Entry Handle.
std::string	nt::GetEntryName (NT_Entry entry)
	Gets the name of the specified entry.
NT_Type	nt::GetEntryType (NT_Entry entry)
	Gets the type for the specified entry, or unassigned if non existent.
int64_t	nt::GetEntryLastChange (NT_Handle subentry)
	Gets the last time the entry was changed.
Value	nt::GetEntryValue (NT_Handle subentry)
	Get Entry Value.
bool	nt::SetDefaultEntryValue (NT_Entry entry, const Value &value)
	Set Default Entry Value.
bool	nt::SetEntryValue (NT_Entry entry, const Value &value)
	Set Entry Value.
void	nt::SetEntryFlags (NT_Entry entry, unsigned int flags)
	Set Entry Flags.
unsigned int	nt::GetEntryFlags (NT_Entry entry)
	Get Entry Flags.
std::vector< Value >	nt::ReadQueueValue (NT_Handle subentry)
	Read Entry Queue.
std::vector< Value >	nt::ReadQueueValue (NT_Handle subentry, unsigned int types)
	Read Entry Queue.

Detailed Description

Function Documentation

GetEntry()

NT_Entry nt::GetEntry	(	NT_Inst	inst,
		std::string_view	name )

Get Entry Handle.

Parameters

inst	instance handle
name	entry name (UTF-8 string)

Returns

entry handle

GetEntryFlags()

unsigned int nt::GetEntryFlags

(

NT_Entry

entry

)

Get Entry Flags.

Parameters

entry

entry handle

Returns

Flags value (bitmask of NT_EntryFlags)

GetEntryLastChange()

int64_t nt::GetEntryLastChange

(

NT_Handle

subentry

)

Gets the last time the entry was changed.

Returns 0 if the handle is invalid.

Parameters

subentry

subscriber or entry handle

Returns

Entry last change time

GetEntryName()

std::string nt::GetEntryName

(

NT_Entry

entry

)

Gets the name of the specified entry.

Returns an empty string if the handle is invalid.

Parameters

entry

entry handle

Returns

Entry name

GetEntryType()

NT_Type nt::GetEntryType

(

NT_Entry

entry

)

Gets the type for the specified entry, or unassigned if non existent.

Parameters

entry

entry handle

Returns

Entry type

GetEntryValue()

Value nt::GetEntryValue

(

NT_Handle

subentry

)

Get Entry Value.

Returns copy of current entry value. Note that one of the type options is "unassigned".

Parameters

subentry

subscriber or entry handle

Returns

entry value

ReadQueueValue() [1/2]

std::vector< Value > nt::ReadQueueValue

(

NT_Handle

subentry

)

Read Entry Queue.

Returns new entry values since last call.

Parameters

subentry

subscriber or entry handle

Returns

entry value array

ReadQueueValue() [2/2]

std::vector< Value > nt::ReadQueueValue	(	NT_Handle	subentry,
		unsigned int	types )

Read Entry Queue.

Returns new entry values since last call.

Parameters

subentry	subscriber or entry handle
types	bitmask of NT_Type values; 0 is treated specially as a "don't care"

Returns

entry value array

SetDefaultEntryValue()

bool nt::SetDefaultEntryValue	(	NT_Entry	entry,
		const Value &	value )

Set Default Entry Value.

Returns False if name exists. Otherwise, sets passed in value, and returns True. Note that one of the type options is "unassigned".

Parameters

entry	entry handle
value	value to be set if name does not exist

Returns

False on error (value not set), True on success

SetEntryFlags()

void nt::SetEntryFlags	(	NT_Entry	entry,
		unsigned int	flags )

Set Entry Flags.

Parameters

entry	entry handle
flags	flags value (bitmask of NT_EntryFlags)

SetEntryValue()

bool nt::SetEntryValue	(	NT_Entry	entry,
		const Value &	value )

Set Entry Value.

Sets new entry value. If type of new value differs from the type of the currently stored entry, returns error and does not update value.

Parameters

entry	entry handle
value	new entry value

Returns

False on error (type mismatch), True on success