Links

cg_link_write	Create a link at the current location
cg_is_link	Test if a node is a link
cg_link_read	Get path information for a link at the current location

Link functions

C Functions	Modes
ier = cg_link_write (char *nodename, char *filename, char *name_in_file);	- w m
ier = cg_is_link (int *path_length);	r - m
ier = cg_link_read (char **filename, char **link_path);	r - m

Fortran interfaces	Modes
call cg_link_write_f (filename, mode, fn, ier)	- w m
call cg_is_link_f (path_length, ier)	r - m
call cg_link_read_f (filename, link_path, ier)	r - m

Input / Ouput

nodename

Name of the link node to create, e.g., GridCoordinates.

filename

Name of the linked file, or empty string if the link is within the same file.

name_in_file

Path name of the node which the link points to. This can be a simple or a compound name, e.g., Base/Zone 1/GridCoordinates.

path_length

Length of the path name of the linked node. The value 0 is returned if the node is not a link.

link_path

Path name of the node which the link points to.

ier

Error status.

Use cg_goto(_f) to position to a location in the file prior to calling these routines.

When using cg_link_write, the node being linked to does not have to exist when the link is created. However, when the link is used, an error will occur if the linked-to node does not exist.

Only nodes that support child nodes will support links.

It is assumed that the CGNS version for the file containing the link, as determined by the CGNSLibraryVersion_t node, is also applicable to filename, the file containing the linked node.

Memory is allocated by the library for the return values of the C function cg_link_read. This memory should be freed by the user when no longer needed by calling cg_free(filename) and cg_free(link_path).