RepositoryDeleteChangelist Method
|
Delete a change from the repository
Namespace:
Perforce.P4
Assembly:
p4api.net (in p4api.net.dll) Version: 2024.1.265.5426
Syntax public void DeleteChangelist(
Changelist change,
Options options
)
Public Sub DeleteChangelist (
change As Changelist,
options As Options
)
public:
void DeleteChangelist(
Changelist^ change,
Options^ options
)
member DeleteChangelist :
change : Changelist *
options : Options -> unit
Parameters
- change
- Type: Perforce.P4Changelist
The change to be deleted - options
- Type: Perforce.P4Options
The '-f' and '-s' flags are valid when deleting an existing change
Return Value
Type:
The Changelist object if new change was found, null if creation failed
Remarks
p4 help change
change -- Create or edit a changelist description
changelist -- synonym for 'change'
p4 change [-s] [-f | -u] [[-O] changelist#]
p4 change -d [-f -s -O] changelist#
p4 change -o [-s] [-f] [[-O] changelist#]
p4 change -i [-s] [-f | -u]
p4 change -t restricted | public [-U user] [-f | -u | -O] changelist#
p4 change -U user [-t restricted | public] [-f] changelist#
'p4 change' creates and edits changelists and their descriptions.
With no argument, 'p4 change' creates a new changelist. If a
changelist number is specified, 'p4 change' edits an existing
pending changelist. In both cases, the changelist specification
is placed into a form and the user's editor is invoked.
The -d flag deletes a pending changelist, if it has no opened files
and no pending fixes associated with it. Use 'p4 opened -a' to
report on opened files and 'p4 reopen' to move them to another
changelist. Use 'p4 fixes -c changelist#' to report on pending
fixes and 'p4 fix -d -c changelist# jobs...' to delete pending
fixes. The changelist can be deleted only by the user and client
who created it, or by a user with 'admin' privilege using the -f
flag.
The -o flag writes the changelist specification to the standard
output. The user's editor is not invoked.
The -i flag reads a changelist specification from the standard
input. The user's editor is not invoked.
The -f flag forces the update or deletion of other users' pending
changelists. -f can also force the deletion of submitted changelists
after they have been emptied of files using 'p4 obliterate'. By
default, submitted changelists cannot be changed. The -f flag can
also force display of the 'Description' field in a restricted
changelist. Finally the -f flag can force changing the 'User' of
an empty pending change via -U. The -f flag requires 'admin'
access granted by 'p4 protect'. The -f and -u flags are mutually
exclusive.
The -u flag can force the update of a submitted change by the owner
of the change. Only the Jobs, Type, and Description fields can be
changed using the -u flag. The -f and -u flags cannot be used in
the same change command.
The -s flag extends the list of jobs to include the fix status
for each job. On new changelists, the fix status begins as the
special status 'ignore', which, if left unchanged simply excludes
the job from those being fixed. Otherwise, the fix status, like
that applied with 'p4 fix -s', becomes the job's status when
the changelist is committed. Note that this option exists
to support integration with external defect trackers.
The -O flag specifies that the changelist number is the original
number of a changelist which was renamed on submit.
The -U flag changes the 'User' of an empty pending change to the
specified user. The user field can only be changed using this flag
by the user who created the change, or by a user with 'admin'
privilege using the -f flag. This option is useful for running
in a trigger or script.
The -t flag changes the 'Type' of the change to 'restricted'
or 'public' without displaying the change form. This option is
useful for running in a trigger or script.
The 'Type' field can be used to hide the change or its description
from users. Valid values for this field are 'public' (default), and
'restricted'. A shelved or committed change that is 'restricted' is
accessible only to users who own the change or have 'list' permission
to at least one file in the change. A pending (not shelved)
restricted change is only accessible to its owner. Public changes
are accessible to all users. This setting affects the output of the
'p4 change', 'p4 changes', and 'p4 describe' commands. Note that
the '-S' flag is required with 'p4 describe' for the command to
enforce shelved rather than pending restricted changelist rules.
If a user is not permitted to have access to a restricted change,
The 'Description' text is replaced with a 'no permission' message
(see 'Type' field). Users with admin permission can override the
restriction using the -f flag.
Examples
To delete pending changelist 34:
Repository.DeleteChangelist(34,null);
To delete pending changelist 34 as an admin user
who is not owner of the change:
ChangeCmdOptions opts = new ChangeCmdOptions(ChangeCmdFlags.Force);
Repository.DeleteChangelist(34, opts);
See Also