gdmcancel

gdmcancel(
{ G_gdmSpec | q_gdmSpecList }
[ x_gdmOptions ]
[ g_xtra ]
)
=> t / nil

Description

Cancels the checked-out status of the library, cell, view, directory, or file that G_gdmSpec represents. Co-managed files in a view are always canceled as a group; co-managed set behavior applies only if G_gdmSpec consists of library elements.

If G_gdmSpec represents a directory that is not a library element, this function works recursively on the directory only if the GDM_RECURSE option was set when G_gdmSpec was created with gdmCreateSpec.

This function is the SKILL equivalent of the gdmcancel shell command.

Arguments

G_gdmSpec	The library, cell, view, directory, or file object for which the check-out status needs to be canceled.
q_gdmSpecList	List containing gdmSpec objects.
x_gdmOptions	This argument is currently ignored. The default is the integer 0.
g_xtra	Contains additional arguments to be passed to the Cancel command of the underlying design management system.

Value Returned

t	The check-out status of the files was canceled.
nil	An error occurred and the check-out status of the files could not be canceled.

Related Topics

gdmCreateSpec

gdmcancel

Return to top