Options Class

A generic list of command options and values.

Options for the resolve command

Options for the stream command

Options for the streams command

Options for the istat command

Options for the branch command

Options for the branches command

Options for the label command

Options for the labels command

Options for the diff2 command

Options for the diff command

Options for the opened command

Options for the fstat command

Options for the files command

Options for the dirs command

Options for the print command

Options for the filelog command

Options for the annotate command

Options for the fixes command

Options for the grep command

Options for the integrated command

Options for the protects command

Options for the protects command (for maximum access level).

Options for the reviews command

Options for the triggers command

Options for the typemap command

Options for the protect command

Options for the counter command

Inheritance Hierarchy

SystemObject
  System.Collections.GenericDictionaryString, String
    Perforce.P4Options
      More...

Namespace: Perforce.P4
Assembly: p4api.net (in p4api.net.dll) Version: 2024.1.265.5426

Syntax

C++

Copy

public class Options : Dictionary<string, string>

Public Class Options
	Inherits Dictionary(Of String, String)

public ref class Options : public Dictionary<String^, String^>

type Options =  
    class
        inherit Dictionary<string, string>
    end

The Options type exposes the following members.

Constructors

	Name	Description
	Options	Construct an blank Options object
	Options(ChangeCmdFlags)	Change command options.
	Options(ClientCmdFlags)	Client command options.
	Options(CounterCmdFlags)	Initializes a new instance of the Options class
	Options(DepotCmdFlags)	Options for the Depot command
	Options(GetProtectionTableCmdFlags)	Initializes a new instance of the Options class
	Options(GetResolvedFilesCmdFlags)	Resolved command options.
	Options(GetStreamMetaDataCmdFlags)	Options for the istat command
	Options(GetTriggerTableCmdFlags)	Initializes a new instance of the Options class
	Options(GetTypeMapCmdFlags)	Initializes a new instance of the Options class
	Options(GroupCmdFlags)	Group command options.
	Options(InfoCmdFlags)	Options for the trust command
	Options(Int32)	Options for the lock command.
	Options(JobCmdFlags)	Options for job command.
	Options(LabelSyncCmdFlags)	Options for the labelsync command.
	Options(LicenseCmdFlags)	Options for the license command
	Options(LogoutCmdFlags)	Options for the logout command.
	Options(TrustCmdFlags)	Options for the trust command
	Options(UserCmdFlags)	User command options.
	Options(ChangeCmdFlags, ChangeListType)	Change command options.
	Options(DeleteFilesCmdFlags, Int32)	Options for the delete command.
	Options(FilesCmdFlags, Int32)	Options for the files command.
	Options(GetDepotDirsCmdFlags, String)	Initializes a new instance of the Options class
	Options(GetDepotFilesCmdFlags, Int32)	Initializes a new instance of the Options class
	Options(GetFileAnnotationsCmdFlags, String)	Initializes a new instance of the Options class
	Options(GetFileContentsCmdFlags, String)	Command options for GetFileContentsCmd()
	Options(GetReviewersCmdFlags, Int32)	Initializes a new instance of the Options class
	Options(GetSubmittedIntegrationsCmdFlags, String)	Initializes a new instance of the Options class
	Options(GroupsCmdFlags, Int32)	Groups command options.
	Options(Int32, FileType)	Options for the reopen command.
	Options(LabelCmdFlags, String)	Options for the Label Command
	Options(LoginCmdFlags, String)	Options for the login command.
	Options(ReconcileFilesCmdFlags, Int32)	Reconcile command options.
	Options(ResolveFilesCmdFlags, Int32)	Options for the resolve command
	Options(RevertFilesCmdFlags, Int32)	Revert command options.
	Options(TagFilesCmdFlags, String)	Options for the tag command.
	Options(UnlockFilesCmdFlags, Int32)	Unlock command options.
	Options(UsersCmdFlags, Int32)	Users command options.
	Options(AddFilesCmdFlags, Int32, FileType)	Options for the Add command.
	Options(BranchSpecCmdFlags, String, String)	Create Branch command options
	Options(DescribeChangelistCmdFlags, Int32, Int32)	Options for the Describe command
	Options(EditFilesCmdFlags, Int32, FileType)	Options for the edit command
	Options(FileLogCmdFlags, Int32, Int32)	Options for the filelog command.
	Options(FixJobsCmdFlags, Int32, String)	Fix command options.
	Options(GetFileHistoryCmdFlags, Int32, Int32)	Initializes a new instance of the Options class
	Options(JobsCmdFlags, String, Int32)	Jobs command options.
	Options(MoveFileCmdFlags, Int32, FileType)	Options for the move command.
	Options(StreamCmdFlags, String, String)	Create Options for a Stream command
	Options(UnshelveFilesCmdFlags, Int32, Int32)	Unshelve command options.
	Options(BranchSpecsCmdFlags, String, String, Int32)	Initializes a new instance of the Options class
	Options(ClientCmdFlags, String, String, Int32)	Client command options.
	Options(GetFileDiffsCmdFlags, Int32, Int32, Int32)	Initializes a new instance of the Options class
	Options(GetFileLineMatchesCmdFlags, Int32, Int32, Int32)	Initializes a new instance of the Options class
	Options(GetFixesCmdFlags, Int32, String, Int32)	Initializes a new instance of the Options class
	Options(GetMaxProtectionAccessCmdFlags, String, String, String)	Initializes a new instance of the Options class
	Options(GetProtectionEntriesCmdFlags, String, String, String)	Initializes a new instance of the Options class
	Options(ClientsCmdFlags, String, String, Int32, String)	Clients command options.
	Options(GetOpenedFilesCmdFlags, String, String, String, Int32)	Options for the opened command
	Options(LabelsCmdFlags, String, String, Int32, String)	Initializes a new instance of the Options class
	Options(StreamsCmdFlags, String, String, String, Int32)	Options for the Streams command
	Options(ChangesCmdFlags, String, Int32, ChangeListStatus, String, Int32)	Changes command options.
	Options(CopyFilesCmdFlags, String, String, String, Int32, Int32)	Copy command options.
	Options(GetDepotFileDiffsCmdFlags, Int32, Int32, String, String, String)	Initializes a new instance of the Options class
	Options(GetFileMetadataCmdFlags, String, String, Int32, String, String)	Obsolete. Options for the fstat command
	Options(IntegrateFilesCmdFlags, Int32, Int32, String, String, String)	Options for the integrate command.
	Options(LabelsCmdFlags, String, String, Int32, String, String)	Initializes a new instance of the Options class
	Options(MergeFilesCmdFlags, String, String, String, Int32, Int32)	Initializes a new instance of the Options class
	Options(StreamsCmdFlags, String, String, String, Int32, String)	Options for the Streams command
	Options(GetFileMetadataCmdFlags, String, String, Int32, String, String, String)	Initializes a new instance of the Options class
	Options(SyncFilesCmdFlags, Int32, Int32, Int32, Int32, Int32, Int32)	Sync command options.
	Options(ShelveFilesCmdFlags, Changelist, Int32, Int32, Int32, Int32, Int32, Int32)	Shelve command options.
	Options(SubmitFilesCmdFlags, Int32, Changelist, String, ClientSubmitOptions, Int32, Int32, Int32, Int32, Int32)	Submit command options

Top

Properties

	Name	Description
	Comparer	(Inherited from DictionaryString, String.)
	Count	(Inherited from DictionaryString, String.)
	Item	(Inherited from DictionaryString, String.)
	Keys	(Inherited from DictionaryString, String.)
	Values	(Inherited from DictionaryString, String.)

Top

Methods

	Name	Description
	Add	(Inherited from DictionaryString, String.)
	Clear	(Inherited from DictionaryString, String.)
	ContainsKey	(Inherited from DictionaryString, String.)
	ContainsValue	(Inherited from DictionaryString, String.)
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetEnumerator	(Inherited from DictionaryString, String.)
	GetHashCode	(Inherited from Object.)
	GetObjectData	(Inherited from DictionaryString, String.)
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	OnDeserialization	(Inherited from DictionaryString, String.)
	Remove	(Inherited from DictionaryString, String.)
	ToString	Dump an Options object as a string (Overrides ObjectToString.)
	ToStringList	Return a StringList describing the options
	TryGetValue	(Inherited from DictionaryString, String.)

Top

Operators

	Name	Description
	(Options to StringList)	Create a StringList from Options

Top

Remarks

p4 help files

files -- List files in the depot

p4 files [ -a ] [ -A ] [ -e ] [ -m max ] file[revRange] ...
p4 files -U unloadfile ...

List details about specified files: depot file name, revision,
file, type, change action and changelist number of the current
head revision. If client syntax is used to specify the file
argument, the client view mapping is used to determine the
corresponding depot files.

By default, the head revision is listed. If the file argument
specifies a revision, then all files at that revision are listed.
If the file argument specifies a revision range, the highest revision
in the range is used for each file. For details about specifying
revisions, see 'p4 help revisions'.

The -a flag displays all revisions within the specific range, rather
than just the highest revision in the range.

The -A flag displays files in archive depots.

The -e flag displays files with an action of anything other than
deleted, purged or archived. Typically this revision is always
available to sync or integrate from.

The -m flag limits files to the first 'max' number of files.

The -U option displays files in the unload depot (see 'p4 help unload'
for more information about the unload depot).

Reference

Perforce.P4 Namespace

Inheritance Hierarchy

Send comments on this topic to manual@perforce.com