dbSetRouteAuthor

dbSetRouteAuthor(
d_routeId
t_authorType
[ t_subAuthorType ]
)
 => t / nil

Description

Sets the author and, optionally, the sub-author type for the specified route.

Arguments

d_routeId	Database ID of a route.
t_authorType	Author type to be set for the route. Valid values: Auto, Manual Any other value will result in an error.
t_subAuthorType	Sub-author type to be set for the route. Valid values: None, Mesh, Spine, Shield, Tie Shield Any other value will result in an error.

Value Returned

t	Specified author type and sub-author type, are set for the given route.
nil	Specified author type is not set for the given route.

Examples

Create a new route.

rt1 = dbCreateRoute(MainCV mainNet t "normal")

=> db:0x1f7b9c1a

Set author type to Auto.

dbSetRouteAuthor(rt1 "Auto")

=> t

Check the author type.

dbGetRouteAuthor(rt1)

=> "Auto"

Create a new route.

rt1 = dbCreateRoute(MainCV mainNet t "normal")

Set author type to Manual and sub-author type to None.

dbSetRouteAuthor(rt1 "Manual" "None")

=> t

Related Topics

Interconnect Functions

Return to top