Holds the various attributes and its values for a server-settable parameter. Only the Value property can be modified.
Determines if the parameter is an advanced command.
object.Advanced
Boolean. Returns TRUE if the parameter is an advanced command; otherwise, FALSE.
Read-only.
This example returns TRUE if the parameter is an advanced command; otherwise, FALSE.
set srv = CreateObject("ucx:Server")
set srvparams = srvr.Params
set paramObj = Srvparams.Get ("TimeSync Add Time Source")
print("Is Advanced " & paramObj.Advanced)
Returns the category number of the settable parameter.
object.Category
Integer. See Remarks below for a list of possible values.
Read-only.
Category Values:
This example returns the category number of the settable parameter.
set srv = CreateObject("ucx:Server")
set srvparams = srvr.Params
set paramObj = Srvparams.Get ("TimeSync Add Time Source")
print("Category number is " & paramObj.Category)
Returns the description of the settable parameter.
object.Description
String.
Read-only.
This example returns the description of the settable parameter.
set srv = CreateObject("ucx:Server")
set srvparams = srvr.Params
set paramObj = Srvparams.Get ("TimeSync Add Time Source")
print("Description is " & paramObj.Description)
Determines whether or not the parameter is internal.
object.Internal
Boolean. Returns TRUE if the parameter is internal; otherwise, FALSE.
Read-only.
These parameters are not typically set by a system administrator. Servman.nlm and the console command SET do not display internal commands. They are intended for use by the developers of the OS and/or components that add them.
This example returns TRUE if the parameter is internal; otherwise, FALSE.
set srv = CreateObject("ucx:Server")
set srvparams = srvr.Params
set paramObj = Srvparams.Get ("TimeSync Add Time Source")
print("Is Internal " & paramObj.Internal)
Defines the lower limit for the settable parameter, if present.
object.LowerLimit
Long.
Read-only.
If the data type is Time Ticks, it represents time in ticks.
This example defines the lower limit for the settable parameter.
set srv = CreateObject("ucx:Server")
set srvparams = srvr.Params
set paramObj = Srvparams.Get ("TimeSync Add Time Source")
print("Lower limit is " & paramObj.LowerLimit)
Returns the settable parameter.
object.Name
String.
Read-only.
This example returns the settable parameter.
set srv = CreateObject("ucx:Server")
set srvparams = srvr.Params
set paramObj = Srvparams.Get ("TimeSync Add Time Source")
print("Name is " & paramObj.Name)
Defines the properties of the Parameter object, such as when it can be set.
object.Nflags
Integer.
Read-only.
All Boolean properties in this object are based on the value of this property.
Possible Integer values are:
This example defines the properties of the Parameter object, such as when it can be set.
set srv = CreateObject("ucx:Server")
set srvparams = srvr.Params
set paramObj = Srvparams.Get ("TimeSync Add Time Source")
print("Flags is " & paramObj.Nflags)
Determines whether or not the parameter can be changed when the console is secure.
object.Nonsecure
Boolean. Returns TRUE if the parameter can be changed when the console is secure; otherwise, FALSE.
Read-only.
This example returns TRUE if the parameter can be changed when the console is secure; otherwise, FALSE.
set srv = CreateObject("ucx:Server")
set srvparams = srvr.Params
set paramObj = Srvparams.Get ("TimeSync Add Time Source")
print("Is Nonsecure " & paramObj.Nonsecure)
Returns the sequence number of the settable parameter.
object.Sequence
Integer.
Read-only.
This example returns the sequence number of the settable parameter.
set srv = CreateObject("ucx:Server")
set srvparams = srvr.Params
set paramObj = Srvparams.Get ("TimeSync Add Time Source")
print("Sequence number is " & paramObj.Sequence)
Determines whether or not the parameter can be set in startup.ncf.
object.StartupOkay
Boolean.
Read-only.
This example returns TRUE if the parameter can be set in startup.ncf.
set srv = CreateObject("ucx:Server")
set srvparams = srvr.Params
set paramObj = Srvparams.Get ("TimeSync Add Time Source")
print("Is StartupOkay " & paramObj.StartupOkay)
Determines whether or not the parameter can be changed only in startup.ncf.
object.StartupOnly
Boolean.
Read-only.
This example returns TRUE if the parameter can be changed only in startup.ncf.
set srv = CreateObject("ucx:Server")
set srvparams = srvr.Params
set paramObj = Srvparams.Get ("TimeSync Add Time Source")
print("Is StartupOnly " & paramObj.StartupOnly)
Returns the data type of the settable parameter.
object.Type
Integer.
Read-only.
This example returns the data type of the settable parameter.
set srv = CreateObject("ucx:Server")
set srvparams = srvr.Params
set paramObj = Srvparams.Get ("TimeSync Add Time Source")
print("Data type is " & paramObj.Type)
Defines the upper limit for the settable parameter, if present.
object.UpperLimit
Long.
Read-only.
If the data type is String, this property contains the maximum string length. If the data type is TimeTicks, it represents time in ticks.
This example defines the upper limit for the settable parameter.
set srv = CreateObject("ucx:Server")
set srvparams = srvr.Params
set paramObj = Srvparams.Get ("TimeSync Add Time Source")
print("Upper limit is " & paramObj.UpperLimit)
Returns the value (of the settable ParamObject) which can be modified.
object.Value[=NewValue As AnyType]
AnyType.
Read-only.
NewValue is an optional parameter that represents the new value for the ParamObject. It can be an Integer or a String.
This example returns the value (of the settable parameter), which can be modified.
set srv = CreateObject("ucx:Server")
set srvparams = srvr.Params
set paramObj = Srvparams.Get ("TimeSync Add Time Source")
print("Value is " & paramObj.Value)