EpicGames.Perforce
Wrapper for a list of filespecs. Allows implicit conversion from string (a single entry) or list.
Empty filespec list
Matches any files in the depot
The list of filespecs
Private constructor. Use implicit conversion operators below instead.
List of filespecs
Test two filespecs for equality
Test two filespecs for inequality
Implicit conversion operator from a list of filespecs
The list to construct from
Implicit conversion operator from an array of filespecs
The array to construct from
Implicit conversion operator from a single filespec
The single filespec to construct from
Runs a background task that logs warnings if the Tick method isn't called within a certain time period
Constructor
Interval after which to log a message
Context for hang messages
Logger to write to
Start monitoring for hangs.
Activity to log if a hang is detected
Marks the operation as ongoing
Base interface for Perforce clients
Connection settings
Logger for this connection
Queues a Perforce command to be executed
The command name
Arguments for the command
File arguments (may be put into a response file)
Input data to be passed to the command
Response for login prompts
Whether to intercept file I/O and return it in the reponse stream. Only supported by the native client.
Response object
Creates a record from a set of input fields
Fields for the record
Serialized record data
Interface for the result of a Perforce operation
Data containing the result
Waits until more data has been read into the buffer.
True if more data was read, false otherwise
Discard bytes from the start of the result buffer
Number of bytes to discard
Utility methods for IPerforceOutput
String constants for records
Standard prefix for a returned record: record indicator, string, 4 bytes, 'code', string, [value]
Constructs an object from a block of data
Data to construct from
Output object
Constructs an object from a response
Response to construct from
Output object
Constructs an object from a sequence of responses
Responses to construct from
Output object
Formats the current contents of the buffer to a string
The next byte that was read
String representation of the buffer
Formats the current contents of the buffer to a string
The data to format
String representation of the buffer
Read a list of responses from the child process
The response to read from
The type of stat record to parse
Cancellation token for the read
Async task
Read a list of responses from the child process
The response to read from
The type of stat record to parse
Cancellation token for the read
Async task
Read a list of responses from the child process
The Perforce response
Delegate to invoke for each record read
Cancellation token for the read
Async task
Reads from the buffer into a record object
The buffer to read from
Current read position within the buffer
List of rows to read into
True if a record could be read; false if more data is required
Reads a response object from the buffer
The buffer to read from
Current read position within the buffer
The type of record expected to parse from the response
Receives the response object on success
True if a response was read, false if the buffer needs more data
Parse an individual record from the server.
The buffer to read from
Current read position within the buffer
Reflection information for the type being serialized into.
Receives the record on success
The parsed object.
Reads a value from the input buffer
The buffer to read from
Current read position within the buffer
The new record
The current tag
Attempts to read a single byte from the buffer
The buffer to read from
Current read position within the buffer
Receives the byte that was read
True if a byte was read from the buffer, false if there was not enough data
Attempts to read a single int from the buffer
The buffer to read from
Current read position within the buffer
Receives the value that was read
True if an int was read from the buffer, false if there was not enough data
Attempts to read a string from the buffer
The buffer to read from
Current read position within the buffer
Receives the value that was read
True if a string was read from the buffer, false if there was not enough data
Experimental implementation of which wraps the native C++ API.
A buffer used for native code to stream data into
Response object for a request
Constructor
Settings for the connection
Logger for messages
Constructor
Settings for the connection
Number of buffers to create for streaming response data
Size of each buffer
Logger for messages
Create an instance of the native client
Check whether the native client is supported on the current platform
Finalizer
Gets the amount of time stalled waiting for an output buffer in the last command
Initializes the connection, throwing an error on failure
Tries to initialize the connection
Error returned when attempting to connect
Background thread which sequences requests on a single thread. The Perforce API isn't async aware, but is primarily
I/O bound, so this thread will mostly be idle. All processing C#-side is done using async tasks, whereas this thread
blocks.
Callback for switching buffers
The complete buffer
Receives information about the next buffer to write to
Converts a Python marshalled data blob to a spec definition
Attributes for fields that should be deserialized from P4 tags
The tag name
Whether this tag is required for a valid record
Constructor
Name of the tag
Specifies the name of an enum when converted into a P4 string
Name of the enum value
Constructor
Name of the serialized value
When attached to a list field, indicates that a list of structures can be included in the record
Represents a change view from a clientspec or stream
List of entries for this change view
Determines if a file revision is visible
Path to the depot file
Change number of the file
Parse a change view from a specification
Lines for the change view
Whether this will be evaluated in the context of a case-insensitive server
Entry for a change view
Pattern to match
Change to be imported at
Constructor
Determine
Wraps a call to a p4.exe child process, and allows reading data from it
The process group
The child process instance
Scope object for tracing
The buffer data
End of the valid portion of the buffer (exclusive)
Temp file containing file arguments
Constructor
Command line arguments
File arguments, which may be placed in a response file
Input data to pass to the child process
Logging device
Gets the path to the P4.EXE executable
Path to the executable
Reads all output from the child process as a string
Cancellation token to abort the read
Exit code and output from the process
Stores settings for communicating with a Perforce server.
Create a new Perforce connection
Create a new Perforce connection
The server address and port
The user name
Interface for logging
Create a new Perforce connection
The server address and port
The user name
The client name
Interface for logging
Create a new Perforce connection
The server address and port
The user name
The client name
Interface for logging
Create a new Perforce connection
Settings for the connection
The current server and port
The current user name
The current host name
The current client name
Name of this application, reported to server through -zprog arguments
Version of this application, reported to server through -zversion arguments
Additional options to append to the command line
The logging interface
Constructor
The server address and port
The user name
Interface for logging
Constructor
The server address and port
The user name
The client name
Interface for logging
Constructor
The server address and port
The user name
The client name
Interface for logging
Constructor
Constructor
Connection to copy settings from
Sets an environment variable
Name of the variable to set
Value for the variable
Token used to cancel the operation
Response from the server
Sets an environment variable
Name of the variable to set
Value for the variable
Token used to cancel the operation
Response from the server
Extension methods for
Create a new connection with a different client
Create a new connection with a different client
Execute a command and parse the response
The Perforce connection
Command to execute
Arguments for the command
Input data to pass to Perforce
The type of records to return for "stat" responses
Token used to cancel the operation
List of objects returned by the server
Execute a command and parse the response
The Perforce connection
Command to execute
Arguments for the command
File arguments for the command
Input data to pass to Perforce
The type of records to return for "stat" responses
Token used to cancel the operation
List of objects returned by the server
Execute a command and parse the response
The Perforce connection
Command to execute
Arguments for the command
File arguments for the command
Input data to pass to Perforce
The type of records to return for "stat" responses
Whether to intercept Io operations and return them in the response output
Token used to cancel the operation
List of objects returned by the server
Execute a command and parse the response
The Perforce connection
Command to execute
Arguments for the command
File arguments for the command
Input data to pass to Perforce
Token used to cancel the operation
List of objects returned by the server
Execute a command and parse the response
The Perforce connection
Command to execute
Arguments for the command
Input data to pass to Perforce
Delegate used to handle each record
Token used to cancel the operation
List of objects returned by the server
Execute a command and parse the response
Connection to the Perforce server
The command to execute
Arguments for the command
Arguments which can be passed into a -x argument
Input data to pass to Perforce
Token used to cancel the operation
List of objects returned by the server
Execute a command and parse the response
Connection to the Perforce server
The command to execute
Arguments for the command
Input data to pass to Perforce
Token used to cancel the operation
List of objects returned by the server
Execute a command and parse the response
Connection to the Perforce server
The command to execute
Arguments for the command
Arguments to pass to the command in batches
Token used to cancel the operation
List of objects returned by the server
Attempts to execute the given command, returning the results from the server or the first PerforceResponse object.
Connection to the Perforce server
The command to execute
Arguments for the command.
Input data for the command.
Type of element to return in the response
Token used to cancel the operation
Response from the server; either an object of type T or error.
Attempts to execute the given command, returning the results from the server or the first PerforceResponse object.
Type of record to parse
Connection to the Perforce server
The command to execute
Arguments for the command.
Input data for the command.
Token used to cancel the operation
Response from the server; either an object of type T or error.
Adds files to a pending changelist.
Connection to the Perforce server
Changelist to add files to
Files to be added
Token used to cancel the operation
Response from the server
Adds files to a pending changelist.
Connection to the Perforce server
Changelist to add files to
Type for new files
Options for the command
Files to be added
Token used to cancel the operation
Response from the server
Adds files to a pending changelist.
Connection to the Perforce server
Changelist to add files to
Files to be added
Token used to cancel the operation
Response from the server
Adds files to a pending changelist.
Connection to the Perforce server
Changelist to add files to
Type for new files
Options for the command
Files to be added
Token used to cancel the operation
Response from the server
Creates a changelist with the p4 change command.
Connection to the Perforce server
Information for the change to create. The number field should be left set to -1.
Token used to cancel the operation
The changelist number, or an error.
Creates a changelist with the p4 change command.
Connection to the Perforce server
Information for the change to create. The number field should be left set to -1.
Token used to cancel the operation
The changelist number, or an error.
Updates an existing changelist.
Connection to the Perforce server
Options for this command
Information for the change to create. The number field should be left set to zero.
Token used to cancel the operation
The changelist number, or an error.
Updates an existing changelist.
Connection to the Perforce server
Options for this command
Information for the change to create. The number field should be left set to zero.
Token used to cancel the operation
The changelist number, or an error.
Deletes a changelist (p4 change -d)
Connection to the Perforce server
Options for the command
Changelist number to delete
Token used to cancel the operation
Response from the server
Deletes a changelist (p4 change -d)
Connection to the Perforce server
Options for the command
Changelist number to delete
Token used to cancel the operation
Response from the server
Gets a changelist
Connection to the Perforce server
Options for the command
Changelist number to retrieve. -1 is the default changelist for this workspace.
Token used to cancel the operation
Response from the server
Gets a changelist
Connection to the Perforce server
Options for the command
Changelist number to retrieve. -1 is the default changelist for this workspace.
Token used to cancel the operation
Response from the server
Serializes a change record to a byte array
Connection to the Perforce server
The record to serialize
Serialized record
Enumerates changes on the server
Connection to the Perforce server
Options for the command
List only the highest numbered changes
Limit the list to the changelists with the given status (pending, submitted or shelved)
Paths to query changes for
Token used to cancel the operation
List of responses from the server.
Enumerates changes on the server
Connection to the Perforce server
Options for the command
List only changes made from the named client workspace.
List only the highest numbered changes
Limit the list to the changelists with the given status (pending, submitted or shelved)
List only changes made by the named user
Paths to query changes for
Token used to cancel the operation
List of responses from the server.
Enumerates changes on the server
Connection to the Perforce server
Options for the command
List only changes made from the named client workspace.
The minimum changelist number
List only the highest numbered changes
Limit the list to the changelists with the given status (pending, submitted or shelved)
List only changes made by the named user
Paths to query changes for
Token used to cancel the operation
List of responses from the server.
Enumerates changes on the server
Connection to the Perforce server
Options for the command
List only the highest numbered changes
Limit the list to the changelists with the given status (pending, submitted or shelved)
Paths to query changes for
Token used to cancel the operation
List of responses from the server.
Enumerates changes on the server
Connection to the Perforce server
Options for the command
List only changes made from the named client workspace.
List only the highest numbered changes
Limit the list to the changelists with the given status (pending, submitted or shelved)
List only changes made by the named user
Paths to query changes for
Token used to cancel the operation
List of responses from the server.
Enumerates changes on the server
Connection to the Perforce server
Options for the command
List only changes made from the named client workspace.
The minimum changelist number
List only the highest numbered changes
Limit the list to the changelists with the given status (pending, submitted or shelved)
List only changes made by the named user
Paths to query changes for
Token used to cancel the operation
List of responses from the server.
Cleans the workspace
Connection to the Perforce server
Options for the command
Files to sync
Token used to cancel the operation
Response from the server
Cleans the workspace
Connection to the Perforce server
Options for the command
Files to sync
Token used to cancel the operation
Response from the server
Creates a client
Connection to the Perforce server
The client record
Token used to cancel the operation
Response from the server
Creates a client
Connection to the Perforce server
The client record
Token used to cancel the operation
Response from the server
Creates a client
Connection to the Perforce server
The client record
Token used to cancel the operation
Response from the server
Update a client
Connection to the Perforce server
The client record
Token used to cancel the operation
Response from the server
Deletes a client
Connection to the Perforce server
Options for this command
Name of the client
Token used to cancel the operation
Response from the server
Deletes a client
Connection to the Perforce server
Options for this command
Name of the client
Token used to cancel the operation
Response from the server
Changes the stream associated with a client
Connection to the Perforce server
The new stream to be associated with the client
Options for this command
Token used to cancel the operation
Response from the server
Changes the stream associated with a client
Connection to the Perforce server
The new stream to be associated with the client
Options for this command
Token used to cancel the operation
Response from the server
Changes a client to mirror a template
Connection to the Perforce server
The new stream to be associated with the client
Token used to cancel the operation
Response from the server
Changes a client to mirror a template
Connection to the Perforce server
The new stream to be associated with the client
Token used to cancel the operation
Response from the server
Queries the current client definition
Connection to the Perforce server
Name of the client. Specify null for the current client.
Token used to cancel the operation
Response from the server; either a client record or error code
Queries the current client definition
Connection to the Perforce server
Name of the client. Specify null for the current client.
Token used to cancel the operation
Response from the server; either a client record or error code
Queries the view for a stream
Connection to the Perforce server
Name of the stream.
Changelist at which to query the stream view
Token used to cancel the operation
Response from the server; either a client record or error code
Queries the view for a stream
Connection to the Perforce server
Name of the stream.
Changelist at which to query the stream view
Token used to cancel the operation
Response from the server; either a client record or error code
Serializes a client record to a byte array
Connection to the Perforce server
The input record
Serialized record data
Queries the current client definition
Connection to the Perforce server
Options for this command
List only client workspaces owned by this user.
Token used to cancel the operation
Response from the server; either a client record or error code
Queries the current client definition
Connection to the Perforce server
Options for this command
List only client workspaces owned by this user.
Token used to cancel the operation
Response from the server; either a client record or error code
Queries the current client definition
Connection to the Perforce server
Options for this command
List only client workspaces matching filter. Treated as case sensitive if [ClientsOptions.CaseSensitiveFilter] is set.
Limit the number of results to return. -1 for all.
List client workspaces associated with the specified stream.
List only client workspaces owned by this user.
Token used to cancel the operation
Response from the server; either a client record or error code
Queries the current client definition
Connection to the Perforce server
Options for this command
List only client workspaces matching filter. Treated as case sensitive if [ClientsOptions.CaseSensitiveFilter] is set.
Limit the number of results to return. -1 for all.
List client workspaces associated with the specified stream.
List only client workspaces owned by this user.
Token used to cancel the operation
Response from the server; either a client record or error code
Execute the 'delete' command
Connection to the Perforce server
The change to add deleted files to
Options for the command
List of file specifications to query
Token used to cancel the operation
List of responses from the server
Execute the 'delete' command
Connection to the Perforce server
The change to add deleted files to
Options for the command
List of file specifications to query
Token used to cancel the operation
List of responses from the server
Queries the current depot definition
Connection to the Perforce server
Name of the client. Specify null for the current client.
Token used to cancel the operation
Response from the server; either a client record or error code
Queries the current depot definition
Connection to the Perforce server
Name of the client. Specify null for the current client.
Token used to cancel the operation
Response from the server; either a client record or error code
Describes a single changelist
Connection to the Perforce server
The changelist number to retrieve description for
Token used to cancel the operation
Response from the server; either a describe record or error code
Describes a single changelist
Connection to the Perforce server
The changelist number to retrieve description for
Token used to cancel the operation
Response from the server; either a describe record or error code
Describes a single changelist
Connection to the Perforce server
Options for the command
Maximum number of files to return
The changelist number to retrieve description for
Token used to cancel the operation
Response from the server; either a describe record or error code
Describes a single changelist
Connection to the Perforce server
Options for the command
Maximum number of files to return
The changelist number to retrieve description for
Token used to cancel the operation
Response from the server; either a describe record or error code
Describes a set of changelists
Connection to the Perforce server
The changelist numbers to retrieve descriptions for
Token used to cancel the operation
List of responses from the server
Describes a set of changelists
Connection to the Perforce server
The changelist numbers to retrieve descriptions for
Token used to cancel the operation
List of responses from the server
Describes a set of changelists
Connection to the Perforce server
Options for the command
Maximum number of files to return
The changelist numbers to retrieve descriptions for
Token used to cancel the operation
List of responses from the server
Describes a set of changelists
Connection to the Perforce server
Options for the command
Maximum number of files to return
The changelist numbers to retrieve descriptions for
Token used to cancel the operation
List of responses from the server
List directories under a depot path
Connection to the Perforce server
Options for the command
List directories mapped for the specified stream
Files to be opened for edit
Token used to cancel the operation
Response from the server
List directories under a depot path
Connection to the Perforce server
Options for the command
List directories mapped for the specified stream
Files to be opened for edit
Token used to cancel the operation
Response from the server
Opens files for edit
Connection to the Perforce server
Changelist to add files to
Files to be opened for edit
Token used to cancel the operation
Response from the server
Opens files for edit
Connection to the Perforce server
Changelist to add files to
Files to be opened for edit
Token used to cancel the operation
Response from the server
Opens files for edit
Connection to the Perforce server
Changelist to add files to
Type for new files
Options for the command
Files to be opened for edit
Token used to cancel the operation
Response from the server
Opens files for edit
Connection to the Perforce server
Changelist to add files to
Type for new files
Options for the command
Files to be opened for edit
Token used to cancel the operation
Response from the server
Execute the 'filelog' command
Connection to the Perforce server
Options for the command
List of file specifications to query
Token used to cancel the operation
List of responses from the server
Execute the 'filelog' command
Connection to the Perforce server
Options for the command
List of file specifications to query
Token used to cancel the operation
List of responses from the server
Execute the 'filelog' command
Connection to the Perforce server
Number of changelists to show. Ignored if zero or negative.
Options for the command
List of file specifications to query
Token used to cancel the operation
List of responses from the server
Execute the 'filelog' command
Connection to the Perforce server
Number of changelists to show. Ignored if zero or negative.
Options for the command
List of file specifications to query
Token used to cancel the operation
List of responses from the server
Execute the 'filelog' command
Connection to the Perforce server
Show only files modified by this changelist. Ignored if zero or negative.
Number of changelists to show. Ignored if zero or negative.
Options for the command
List of file specifications to query
Token used to cancel the operation
List of responses from the server
Execute the 'filelog' command
Connection to the Perforce server
Show only files modified by this changelist. Ignored if zero or negative.
Number of changelists to show. Ignored if zero or negative.
Options for the command
List of file specifications to query
Token used to cancel the operation
List of responses from the server
Execute the 'files' command
Connection to the Perforce server
Options for the command
List of file specifications to query
Token used to cancel the operation
List of response objects
Execute the 'files' command
Connection to the Perforce server
Options for the command
List of file specifications to query
Token used to cancel the operation
List of response objects
Execute the 'files' command
Connection to the Perforce server
Options for the command
Maximum number of results to return. Ignored if less than or equal to zero.
List of file specifications to query
Token used to cancel the operation
List of response objects
Execute the 'files' command
Connection to the Perforce server
Options for the command
Maximum number of results to return. Ignored if less than or equal to zero.
List of file specifications to query
Token used to cancel the operation
List of response objects
Execute the 'fstat' command
Connection to the Perforce server
List of file specifications to query
Token used to cancel the operation
List of responses from the server
Execute the 'fstat' command
Connection to the Perforce server
Options for the command
List of file specifications to query
Token used to cancel the operation
List of responses from the server
Execute the 'fstat' command
Connection to the Perforce server
Options for the command
List of file specifications to query
Token used to cancel the operation
List of responses from the server
Execute the 'fstat' command
Connection to the Perforce server
Produce fstat output for only the first max files.
Options for the command
List of file specifications to query
Token used to cancel the operation
List of responses from the server
Execute the 'fstat' command
Connection to the Perforce server
Produce fstat output for only the first max files.
Options for the command
List of file specifications to query
Token used to cancel the operation
List of responses from the server
Execute the 'fstat' command
Connection to the Perforce server
Return only files affected after the given changelist number.
Return only files affected by the given changelist number.
List only those files that match the criteria specified.
Fields to return in the output
Produce fstat output for only the first max files.
Options for the command
List of file specifications to query
Token used to cancel the operation
List of responses from the server
Execute the 'fstat' command
Connection to the Perforce server
Return only files affected after the given changelist number.
Return only files affected by the given changelist number.
List only those files that match the criteria specified.
Fields to return in the output
Produce fstat output for only the first max files.
Options for the command
List of file specifications to query
Token used to cancel the operation
List of responses from the server
Determine files currently synced to the client
Connection to the Perforce server
Files to query
Token used to cancel the operation
List of file records
Determine files currently synced to the client
Connection to the Perforce server
Files to query
Token used to cancel the operation
List of file records
Execute the 'info' command
Connection to the Perforce server
Options for the command
Token used to cancel the operation
Response from the server; an InfoRecord or error code
Execute the 'info' command
Connection to the Perforce server
Options for the command
Token used to cancel the operation
Response from the server; an InfoRecord or error code
Log in to the server
Attempts to log in to the server
Connection to use
Attempts to log in to the server
Connection to use
Options for the command
User to login as
Password for the user
Host for the ticket
Gets the state of the current user's login
Connection to the Perforce server
Token used to cancel the operation
Gets the state of the current user's login
Connection to the Perforce server
Token used to cancel the operation
Execute the 'merge' command
Connection to the Perforce server
Options for the merge
Maximum number of files to merge
The source filespec and revision range
The target filespec
Cancellation token
List of records
Opens files for move
Connection to the Perforce server
Changelist to add files to
Type for new files
Options for the command
The source file(s)
The target file(s)
Token used to cancel the operation
Response from the server
Opens files for move
Connection to the Perforce server
Changelist to add files to
Type for new files
Options for the command
The source file(s)
The target file(s)
Token used to cancel the operation
Response from the server
Execute the 'opened' command
Connection to the Perforce server
Options for the command
Specification for the files to list
Token used to cancel the operation
Response from the server
Execute the 'opened' command
Connection to the Perforce server
Options for the command
Specification for the files to list
Token used to cancel the operation
Response from the server
Execute the 'opened' command
Connection to the Perforce server
Options for the command
List the files in pending changelist change. To list files in the default changelist, use DefaultChange.
List only files that are open in the given client
List only files that are opened by the given user
Maximum number of results to return
Specification for the files to list
Token used to cancel the operation
Response from the server
Execute the 'opened' command
Connection to the Perforce server
Options for the command
List the files in pending changelist change. To list files in the default changelist, use DefaultChange.
List only files that are open in the given client
List only files that are opened by the given user
Maximum number of results to return
Specification for the files to list
Token used to cancel the operation
Response from the server
Execute the 'print' command
Connection to the Perforce server
Output file to redirect output to
Specification for the files to print
Token used to cancel the operation
Response from the server
Execute the 'print' command
Connection to the Perforce server
Output file to redirect output to
Specification for the files to print
Token used to cancel the operation
Response from the server
Execute the 'print' command
Connection to the Perforce server
Specification for the files to print
Token used to cancel the operation
Response from the server
Execute the 'print' command
Connection to the Perforce server
Specification for the files to print
Token used to cancel the operation
Response from the server
Execute the 'print' command
Connection to the Perforce server
Output file to redirect output to
Specification for the files to print
Token used to cancel the operation
Response from the server
Execute the 'print' command for a single file
Connection to the Perforce server
Output file to redirect output to
Specification for the files to print
Token used to cancel the operation
Response from the server
Open files for add, delete, and/or edit in order to reconcile a workspace with changes made outside of Perforce.
Connection to the Perforce server
Changelist to open files to
Options for the command
Files to be reverted
Token used to cancel the operation
Response from the server
Open files for add, delete, and/or edit in order to reconcile a workspace with changes made outside of Perforce.
Connection to the Perforce server
Changelist to open files to
Options for the command
Files to be reverted
Token used to cancel the operation
Response from the server
Reopen a file
Connection to the Perforce server
Changelist to open files to
New filetype
Files to be reverted
Token used to cancel the operation
Response from the server
Reopen a file
Connection to the Perforce server
Changelist to open files to
New filetype
Files to be reverted
Token used to cancel the operation
Response from the server
Reloads a client workspace
Connection to the Perforce server
Name of the client to reload
The source server id
Token used to cancel the operation
Response from the server
Resolve conflicts between file revisions.
Connection to the Perforce server
Changelist to open files to
Options for the command
Files to be reverted
Token used to cancel the operation
Response from the server
Resolve conflicts between file revisions.
Connection to the Perforce server
Changelist to open files to
Options for the command
Files to be reverted
Token used to cancel the operation
Response from the server
Reverts files that have been added to a pending changelist.
Connection to the Perforce server
Changelist to add files to
Revert another user’s open files.
Options for the command
Files to be reverted
Token used to cancel the operation
Response from the server
Reverts files that have been added to a pending changelist.
Connection to the Perforce server
Changelist to add files to
Revert another user’s open files.
Options for the command
Files to be reverted
Token used to cancel the operation
Response from the server
Gets information about the specified server
Connection to the Perforce server
The server identifier
Token used to cancel the operation
Gets information about the specified server
Connection to the Perforce server
The server identifier
Token used to cancel the operation
Shelves a set of files
Connection to the Perforce server
The change number to receive the shelved files
Options for the command
Files to sync
Token used to cancel the operation
Response from the server
Shelves a set of files
Connection to the Perforce server
The change number to receive the shelved files
Options for the command
Files to sync
Token used to cancel the operation
Response from the server
Deletes files from a shelved changelist
Connection to the Perforce server
Changelist containing shelved files to be deleted
Files to delete
Token used to cancel the operation
Response from the server
Deletes files from a shelved changelist
Connection to the Perforce server
Changelist containing shelved files to be deleted
Files to delete
Token used to cancel the operation
Response from the server
Execute the 'sizes' command
Connection to the Perforce server
Options for the command
List of file specifications to query
Token used to cancel the operation
List of response objects
Execute the 'sizes' command
Connection to the Perforce server
Options for the command
List of file specifications to query
Token used to cancel the operation
List of response objects
Execute the 'sizes' command
Connection to the Perforce server
Options for the command
Maximum number of results to return. Ignored if less than or equal to zero.
List of file specifications to query
Token used to cancel the operation
List of response objects
Execute the 'sizes' command
Connection to the Perforce server
Options for the command
Maximum number of results to return. Ignored if less than or equal to zero.
List of file specifications to query
Token used to cancel the operation
List of response objects
Queries information about a stream
Connection to the Perforce server
Name of the stream to query
Whether to include the stream view in the output
Token used to cancel the operation
Stream information record
Queries information about a stream
Connection to the Perforce server
Name of the stream to query
Whether to include the stream view in the output
Token used to cancel the operation
Stream information record
Updates an existing stream
Connection to the Perforce server
Information of the stream to update
Token used to cancel the operation
Stream information record
Serializes a client record to a byte array
Connection to the Perforce server
The input record
Serialized record data
Enumerates all streams in a depot
Connection to the Perforce server
The path for streams to enumerate (eg. "//UE4/...")
Token used to cancel the operation
List of streams matching the given criteria
Enumerates all streams in a depot
Connection to the Perforce server
The path for streams to enumerate (eg. "//UE4/...")
Token used to cancel the operation
List of streams matching the given criteria
Enumerates all streams in a depot
Connection to the Perforce server
The path for streams to enumerate (eg. "//UE4/...")
Maximum number of results to return
Additional filter to be applied to the results
Whether to enumerate unloaded workspaces
Token used to cancel the operation
List of streams matching the given criteria
Enumerates all streams in a depot
Connection to the Perforce server
The path for streams to enumerate (eg. "//UE4/...")
Maximum number of results to return
Additional filter to be applied to the results
Whether to enumerate unloaded workspaces
Token used to cancel the operation
List of streams matching the given criteria
Submits a pending changelist
Connection to the Perforce server
The changelist to submit
Options for the command
Token used to cancel the operation
Response from the server
Submits a pending changelist
Connection to the Perforce server
The changelist to submit
Options for the command
Token used to cancel the operation
Response from the server
Submits a shelved changelist
Connection to the Perforce server
The changelist to submit
Token used to cancel the operation
Response from the server
Submits a pending changelist
Connection to the Perforce server
The changelist to submit
Token used to cancel the operation
Response from the server
Syncs files from the server
Connection to the Perforce server
Files to sync
Token used to cancel the operation
Response from the server
Syncs files from the server
Connection to the Perforce server
Files to sync
Token used to cancel the operation
Response from the server
Syncs files from the server
Connection to the Perforce server
Options for the command
Files to sync
Token used to cancel the operation
Response from the server
Syncs files from the server
Connection to the Perforce server
Options for the command
Files to sync
Token used to cancel the operation
Response from the server
Syncs files from the server
Connection to the Perforce server
Options for the command
Syncs only the first number of files specified.
Files to sync
Token used to cancel the operation
Response from the server
Syncs files from the server
Connection to the Perforce server
Options for the command
Syncs only the first number of files specified.
Files to sync
Token used to cancel the operation
Response from the server
Syncs files from the server
Connection to the Perforce server
Options for the command
Syncs only the first number of files specified
Sync in parallel using the given number of threads
The number of files in a batch
The number of bytes in a batch
Minimum number of files in a parallel sync
Minimum number of bytes in a parallel sync
Files to sync
Token used to cancel the operation
Response from the server
Syncs files from the server
Connection to the Perforce server
Options for the command
Syncs only the first number of files specified
Sync in parallel using the given number of threads
The number of files in a batch
The number of bytes in a batch
Minimum number of files in a parallel sync
Minimum number of bytes in a parallel sync
Files to sync
Token used to cancel the operation
Response from the server
Syncs files from the server
Connection to the Perforce server
Options for the command
Syncs only the first number of files specified.
Files to sync
Token used to cancel the operation
Response from the server
Syncs files from the server
Connection to the Perforce server
Options for the command
Syncs only the first number of files specified.
Files to sync
Token used to cancel the operation
Response from the server
Syncs files from the server without returning detailed file info
Connection to the Perforce server
Options for the command
Syncs only the first number of files specified
Sync in parallel using the given number of threads
The number of files in a batch
The number of bytes in a batch
Minimum number of files in a parallel sync
Minimum number of bytes in a parallel sync
Files to sync
Token used to cancel the operation
Response from the server
Syncs files from the server without returning detailed file info
Connection to the Perforce server
Options for the command
Syncs only the first number of files specified
Sync in parallel using the given number of threads
The number of files in a batch
The number of bytes in a batch
Minimum number of files in a parallel sync
Minimum number of bytes in a parallel sync
Files to sync
Token used to cancel the operation
Response from the server
Gets arguments for a sync command
Connection to the Perforce server
Options for the command
Syncs only the first number of files specified
Sync in parallel using the given number of threads
The number of files in a batch
The number of bytes in a batch
Minimum number of files in a parallel sync
Minimum number of bytes in a parallel sync
Files to sync
Whether to use quiet output
Token used to cancel the operation
Arguments for the command
Restore shelved files from a pending change into a workspace
Connection to the Perforce server
The changelist containing shelved files
The changelist to receive the unshelved files
The branchspec to use when unshelving files
Specifies the use of a stream-derived branch view to map the shelved files between the specified stream and its parent stream.
Unshelve to the specified parent stream. Overrides the parent defined in the source stream specification.
Options for the command
Files to unshelve
Token used to cancel the operation
Response from the server
Restore shelved files from a pending change into a workspace
Connection to the Perforce server
The changelist containing shelved files
The changelist to receive the unshelved files
The branchspec to use when unshelving files
Specifies the use of a stream-derived branch view to map the shelved files between the specified stream and its parent stream.
Unshelve to the specified parent stream. Overrides the parent defined in the source stream specification.
Options for the command
Files to unshelve
Token used to cancel the operation
Response from the server
Enumerates all streams in a depot
Connection to the Perforce server
Name of the user to fetch information for
Token used to cancel the operation
Response from the server
Enumerates all streams in a depot
Connection to the Perforce server
Name of the user to fetch information for
Token used to cancel the operation
Response from the server
Enumerates all streams in a depot
Connection to the Perforce server
Options for the command
Maximum number of results to return
Token used to cancel the operation
Response from the server
Enumerates all streams in a depot
Connection to the Perforce server
Options for the command
Maximum number of results to return
Token used to cancel the operation
Response from the server
Retrieves the location of a file of set of files in the workspace
Connection to the Perforce server
Patterns for the files to query
Token used to cancel the operation
List of responses from the server
Retrieves the location of a file of set of files in the workspace
Connection to the Perforce server
Patterns for the files to query
Token used to cancel the operation
List of responses from the server
perform undo on a changelist (p4 undo -c [targetCL] //...@undoCL)
Connection to the Perforce server
Changelist number to undo
Changelist number to receive the changes
Token used to cancel the operation
Response from the server
perform undo on a changelist (p4 undo -c [targetCL] //...@undoCL)
Connection to the Perforce server
Changelist number to undo
Changelist number to receive the changes
Token used to cancel the operation
Response from the server
Runs the annotate p4 command
Connection to the Perforce server
Depot path to the file
Options for the anotate command
Token used to cancel the operation
List of annotate records
Runs the annotate p4 command
Connection to the Perforce server
Depot path to the file
Options for the anotate command
Token used to cancel the operation
List of annotate records
Gets the current stream that a client is connected to
Connection to the Perforce server
Token used to cancel the operation
Gets the current stream that a client is connected to
Connection to the Perforce server
Token used to cancel the operation
Interface describing a set of perforce environment settings
Get the value of a particular variable
Name of the variable to retrieve
The variable value, or null if it's not set
The global Perforce environment
Environment variables in the global environment
Constructor
Default global environment used by Linux and MacOS, which reads settings from the registry.
Environment variables read from a file
The parent environment block
Location of the file containing these variables
Constructor
Static methods for retrieving the Perforce environment
Default environment regardless of directroy.
Read the default Perforce settings reading any config file from the given directory
The directory to read from
Default settings for the given directory
Error severity codes. Taken from the p4java documentation.
Generic error codes that can be returned by the Perforce server. Taken from the p4java documentation.
Represents a error return value from Perforce.
The severity of this error
The generic error code associated with this message
The message text
Private constructor for serialization
Formats this error for display in the debugger
String representation of this object
Represents an exception specific to perforce
For errors returned by the server, contains the error record
Constructor
Message for the exception
Constructor
Format string
Arguments for the formatted string
Constructor
The error from the server
Constructor
Generic class for parsing "info" responses from Perforce
Message data
Private constructor for serialization
Formats this error for display in the debugger
String representation of this object
The severity of this error
The generic error code associated with this message
The message text
Logger which adds Perforce depot path and changelist information to file annotations
Accessor for the inner logger
Constructor
Adds a new client to be included in the mapping
Base directory for the client
Depot path for the workspace mapping, in the form //foo/bar...
Changelist for the client
Adds a new client to be included in the mapping
The type of a value returned by Perforce
A utf-8 encoded string
A 32-bit integer
Wrapper for values returned by Perforce
The raw data for the value, including type, size, and payload
Constructor
The data to construct this value from
Create a value from a string
String value to serialize
Determines if the value is empty
True if the value is empty
Accessor for the type of value stored by this struct
Converts the value to a boolean
The boolean value
Converts the value to an integer
Integer value
Converts this value to a long
The converted value
Converts this value to a DateTimeOffset
The converted value
Converts this value to a string
The converted value
Gets the contents of this string
Gets the contents of this string
Convert to a string
String representation of the value
Low-overhead record type for generic responses
The rows in this record
Create a record from a set of fields
Fields to serialize
Whether to number list elements when flattening the record
Record containing the given fields
Copy this record into the given array of values. This method is O(n) if every record key being in the list of keys in the same order, but O(n^2) if not.
List of keys to parse
Array to receive the list of values
Serialize to a single block of data
Serialized data
Serializes a list of key/value pairs into binary format.
List of key value pairs
Serialized record data
String constants for perforce values
Delegate type for creating a record instance
New instance
Information about a nested record
Information about a nested record
Name and rank of a tagged property within a record
Name and rank of a tagged property within a record
Stores cached information about a property with a attribute.
Name of the tag. Specified in the attribute or inferred from the field name.
Whether this tag is optional or not.
List of nested records before getting to the target object
The property containing the value of this data.
Writes an instance of this field from an object
Parser for this field type
Parser for this field type
Index into the bitmask of required types
Constructor
Stores cached information about a record
Type of the record
Method to construct this record
List of fields in the record. These should be ordered to match P4 output for maximum efficiency.
Map of name to tag info
Bitmask of all the required tags. Formed by bitwise-or'ing the RequiredTagBitMask fields for each required CachedTagInfo.
Constructor
The record type
Method used to create an instance of this record
Information about an enum
The enum type
Whether the enum has the [Flags] attribute
Map of name to value
Map of value to name
List of name/value pairs
Constructor
The type to construct from
Gets the name of a particular enum value
Parses the given integer as an enum
The value to convert to an enum
The enum value corresponding to the given value
Parses the given text as an enum
The text to parse
The enum value corresponding to the given text
Parses the given text as an enum
Parses an enum value, using PerforceEnumAttribute markup for names.
Value of the enum.
Text for the enum.
Utility methods for converting to/from native types
Unix epoch; used for converting times back into C# datetime objects
Constant for the default changelist, where valid.
Cached map of enum types to a lookup mapping from p4 strings to enum values.
Cached set of record
Default type for info
Default type for errors
Default type for errors
Serializes a sequence of objects to a stream
Object to serialize
Writer for output data
Gets a mapping of flags to enum values for the given type
The enum type to retrieve flags for
Map of name to enum value
Parses an enum value, using PerforceEnumAttribute markup for names.
Type of the enum to parse.
Value of the enum.
Text for the enum.
Gets reflection data for the given record type
The type to retrieve record info for
The cached reflection information for the given type
Base class for returning untyped response data
Stores the response data
Constructor
The response data
True if the response is successful
True if the response is an error
Accessor for the succcessful response data. Throws an exception if the response is an error.
Returns the info data.
Returns the error data, or null if this is a succesful response.
Returns the io data, or null if this is a regular response.
Throws an exception if the response is an error
Returns a string representation of this object for debugging
String representation of the object for debugging
Represents a successful Perforce response of the given type, or an error. Throws a PerforceException with the error
text if the response value is attempted to be accessed and an error has occurred.
Type of data returned on success
Constructor
The successful response data
Constructor
The info data
Constructor
The error data
Construct a typed response from an untyped response
The untyped response
Accessor for the succcessful response data. Throws an exception if the response is an error.
Extension methods for responses
Whether all responses in this list are successful
Sequence of all the error responses.
Throws an exception if any response is an error
Unwrap a task returning a response object
Represents a list of responses from the Perforce server. Within the list, individual responses
may indicate success or failure.
Successful response type
Default constructor
Constructor
Initial contents of the list
Whether all responses in this list are successful
Returns the first error, or null.
Sequence of all the data objects from the responses.
Sequence of all the error responses.
Throws an exception if any response is an error
Settings for a new Perforce connection
Server and port to connect to
Username to log in with
Password to use
Name of the current host
Name of the client to use
The invoking application name
The invoking application version
Whether to create a native client rather than running the p4 child process, if possible
Whether to monitor the connection for commands that are not producing any output
Settings for a new Perforce connection
The default settings
Default app name to use for new settings objects
Default version string to use for new settings objects
Default constructor
Constructor
Server and port to connect with
Username to connect with
Copy constructor
Get the Perforce settings for a particular directory, reading any necessary P4CONFIG and P4ENVIRO files
Extension methods for setting objects
Update common fields in a IPerforceSettings object
Gets the command line arguments to launch an external program, such as P4V or P4VC
Utility methods for dealing with Perforce paths
Set of extensions to treat as code
Tests if a path is a code file
Path to test
True if the path is a code file
Escape a path to Perforce syntax
Remove escape characters from a path
Remove escape characters from a UTF8 path
Get the relative path of a client file (eg. //ClientName/Foo/Bar.txt -> Foo/Bar.txt)
Path to the client file
Get the relative path within a client from a filename
Dierctory containing the file
File to get the path for
Filters a view of files
List of entries making up the view
Construct from an existing set of entries
Construct a view filter from a set of entries
Determines if a file is included in the view
The file to test
The comparison type
True if the file is included in the view
Entry within a view filter
Whether to include files matching this pattern
The wildcard string - either '*' or '...'
The part of pattern before the wildcard
The part of pattern after the wildcard. Perforce does not permit a slash to be in this part of the file spec filter.
Tests if the entry has a file wildcard ('*')
True if the entry has a file wildcard
Tests if the entry has a path wildcard ('...')
True if the entry has a path wildcard
Constructor
Constructor
Parse a view filter entry from a string, as returned by spec documents
Determine if a file matches the current entry
Path to the file
The comparison type
True if the path matches the entry
Stores a mapping from one set of paths to another
List of entries making up the view
Default constructor
Construct from an existing set of entries
Constructor
Construct a view map from a set of entries
Gets the inverse of this mapping
Determines if a file is included in the view
The file to test
The comparison type
True if the file is included in the view
Maps a set of files into the target files
List of source files
Comparison to use for strings
List of files in the target domain, excluding any not covered by the mapping
Attempts to convert a source file to its target path
The comparison type
Gets the root paths from the view entries
Entry within a ViewMap
Whether to include files matching this pattern
The wildcard string - either '*' or '...'
The source part of the pattern before the wildcard
The source part of the pattern after the wildcard. Perforce does not permit a slash to be in this part of the mapping.
The target mapping for the pattern before the wildcard
The target mapping for the pattern after the wildcard
The full source pattern
The full target pattern
Tests if the entry has a file wildcard ('*')
True if the entry has a file wildcard
Tests if the entry has a path wildcard ('...')
True if the entry has a path wildcard
Constructor
Constructor
Constructor
Parse a view map entry from a string, as returned by spec documents
Maps a file to the target path
Determine if a file matches the current entry
Path to the file
The comparison type
True if the path matches the entry
Options for the p4 add command
No options specified
Downgrade file open status to simple add.
Force inclusion of wildcards in filenames.
Do not perform any ignore checking; ignore any settings specified by P4IGNORE.
Preview which files would be opened for add, without actually changing any files or metadata.
Contains information about an added file
Path to the file in the depot
Path to the file in the workspace
The working revision number of the file that was synced
Action taken when syncing the file
Type of the file
Private constructor for serialization
Format this record for display in the debugger
Summary of this revision
The upper changelist
The lower changelist
Timestamp of this modification
Private constructor for serialization
Format this record for display in the debugger
Summary of this revision
No options specified
includes both deleted files and lines no longer present
at the head revision. In the latter case, both the starting and ending
revision for each line is displayed.
ignore whitespace changes
follows all integrations into the file. If a line was
introduced into the file by a merge, the source of the merge is
displayed as the changelist that introduced the line. If the source
itself was the result of an integration, that source is used instead,
and so on.
directs the annotate command to output the user who
modified the line in the file and the date it was modified.
The revision number of this file
The changelist responsible for this revision of the file
Type of the file
The upper changelist
The lower changelist
Author of the changelist
Timestamp of this modification
Client that submitted this changelist
The actual line
Private constructor for serialization
Format this record for display in the debugger
Summary of this revision
Contains summary information about a changelist
The changelist number. -1 for "new".
The date the change was last modified
The user that owns or submitted the change
The client that owns the change
Current changelist status
Whether the change is restricted or not
Description for the changelist
Files that are open in this changelist
Options for the 'changes' command
No options specified
Include changelists that affected files that were integrated with the specified files.
Display the time as well as the date of each change.
List long output, with the full text of each changelist description.
List long output, with the full text of each changelist description truncated at 250 characters.
View restricted changes (requires admin permission)
Contains summary information about a changelist
The changelist number
The date the change was last modified
The user that owns or submitted the change
The client that owns the change
Current changelist status
Whether the change is restricted or not
The path affected by this change.
Description for the changelist
Indicates the status of a changelist
Include all changes
The change is still pending
The change has been submitted
The change is shelved
The type of a changelist
When creating a new changelist, leaves the changelist type unspecified.
This change is visible to anyone
This change is restricted
Options for the p4 clean command
User default options
Edited files: Find files in the workspace that have been modified and restore them to the last file version that has synced from the depot.
Added files: Find files in the workspace that have no corresponding files in the depot and delete them.
Deleted files: Find those files in the depot that do not exist in your workspace and add them to the workspace.
Preview the results of the operation without performing any action.
Do not perform any ignore checking; ignore any settings specified by P4IGNORE for added files.
Include file paths in local syntax
Use modified times to determine whether files are out of date (see https://community.perforce.com/s/article/15133)
Record returned by the p4 clean command
Depot path of the file, according to the workspace mapping
Client path to the file (in local path syntax)
Path to the file in local syntax
Revision of the file
Action to be taken to the file
Specifies how to treat line endings on files synced to the client
This value is not specified
Use mode native to the client (default)
UNIX-style (and Mac OS X) line endings: LF
Mac pre-OS X: CR only
Windows-style: CR + LF.
The share option normalizes mixed line-endings into UNIX line-end format.
Options for the client
No options are set
If set, unopened files in the workspace are left writable.
Opposite of AllWrite.
If set, a p4 sync overwrites ("clobbers") writable-but-unopened files in the workspace that have the same name as the newly-synced files.
Opposite of Clobber.
If set, a p4 sync overwrites ("clobbers") writable-but-unopened files in the workspace that have the same name as the newly-synced files.
Opposite of Compress.
If set, a p4 sync overwrites ("clobbers") writable-but-unopened files in the workspace that have the same name as the newly-synced files.
Opposite of Locked.
For files without the +m (modtime) file type modifier, the modification date (on the local filesystem) of a newly synced file is the datestamp on the file when the file was last modified.
For files without the +m (modtime) file type modifier, the modification date is the date and time of sync, regardless of version.
If set, p4 sync deletes empty directories in a workspace if all files in the directory have been removed.
Opposite of Rmdir.
If set, and a Helix Core Virtual File Service (P4VFS) application is installed to make use of P4ALTSYNC, the client can create, delete, or update placeholders of the file metadata instead of always taking time to download the full file content.
Opposite of AltSync.
Represents a Perforce clientspec
The client workspace name, as specified in the P4CLIENT environment variable or its equivalents.
The Perforce user name of the user who owns the workspace.
The date the workspace specification was last modified.
The date and time that the workspace was last used in any way.
The name of the workstation on which this workspace resides.
A textual description of the workspace.
Name of the server containing this change.
The directory (on the local host) relative to which all the files in the View: are specified.
A set of seven switches that control particular workspace options.
Options to govern the default behavior of p4 submit.
Configure carriage-return/linefeed (CR/LF) conversion.
Associates the workspace with the specified stream.
The type of client.
Specifies the mappings between files in the depot and files in the workspace.
Private constructor for serialization
Constructor
Name of the client
Owner of the client
The root directory to sync
Options for the p4 clients command
No options
List all client workspaces, not just workspaces bound to this server
Treat the filter argument as case sensitive
Display the time as well as the date of the last update to the workspace.
List only client workspaces unloaded with p4 unload.
Record returned by the p4 clients command
The client workspace name, as specified in the P4CLIENT environment variable or its equivalents.
The Perforce user name of the user who owns the workspace.
The date the workspace specification was last modified.
The date and time that the workspace was last used in any way.
The name of the workstation on which this workspace resides.
A textual description of the workspace.
The directory (on the local host) relative to which all the files in the View: are specified.
A set of seven switches that control particular workspace options.
Options to govern the default behavior of p4 submit.
Configure carriage-return/linefeed (CR/LF) conversion.
Associates the workspace with the specified stream.
The edge server ID
Private constructor for serialization
Format this record for display in the debugger
Summary of this revision
Client options for controlling the default behavior of p4 submit
This field is not set
All open files (with or without changes) are submitted to the depot.
All open files (with or without changes) are submitted to the depot, and all files are automatically reopened in the default changelist.
Only those files with content, type, or resolved changes are submitted to the depot.
Only those files with content, type, or resolved changes are submitted to the depot and reopened in the default changelist.
Only those files with content, type, or resolved changes are submitted to the depot. Any unchanged files are moved to the default changelist.
Only those files with content, type, or resolved changes are submitted to the depot.
Options for the DeleteChange command (p4 change -d)
No options are specified
Forcibly delete a previously submitted changelist.
If a changelist was renumbered on submit, and you know only the original changelist number, use OriginalChangeNumber and the original changelist number to view or edit the changelist.
Options for the p4 client -d command
No options
Administrators can use the -f option to delete or modify locked workspaces owned by other users.
Allows the deletion of a client even when that client contains shelved changes. Requires the Force option.
Options for the p4 delete command
No options specified
Keep existing workspace files; mark the file as open for edit even if the file is not in the client view.
Preview which files would be opened for edit, without actually changing any files or metadata.
Perform the delete without syncing files
Information about a file opened for delete
Path to the file in the depot
Path to the file in the workspace
The working revision number of the file that was synced
Action taken when syncing the file
Type of the file
Private constructor for serialization
Format this record for display in the debugger
Summary of this revision
Information about a file opened for delete
Depot name
Owner of the depot
Creation time
Depot Type
Depot Description
Depot Stream Depth (number of slashes after depot that define the stream name)
A string containing either an integer value or an example path (i.e. //depot/foo/bar represents a depth of 2)
Helper to get Depot Stream Depth (number of slashes after depot that define the stream name) as an integer
Contains information about an individual file in a returned DescribeRecord
Path to the modified file in depot syntax
The action performed on this file
The file type after this change
The revision number for this file
Size of the file, or -1 if not specified
Digest of the file, or null if not specified
Private constructor for serialization
Format this record for display in the debugger
Summary of this revision
Options for the p4 describe command
No options specified
Force the display of descriptions for restricted changelists. This option requires admin permission.
Specifies that the changelist number is the Identity field of a changelist.
If a changelist was renumbered on submit, and you know only the original changelist number, use -O and the original changelist number to describe the changelist.
Display the names of files shelved for the specified changelist, including the diff of each file against its previous depot revision.
Detailed description of an individual changelist
The changelist number
The user that owns or submitted the change
The workspace that contains or submitted the change
Time at which the change was submitted
The changelist description
The change status (submitted, pending, etc...)
Whether the change is restricted or not
Narrowest path which contains all files affected by this change
The files affected by this change
Private constructor for serialization
Format this record for display in the debugger
Summary of this revision
Options for the p4 dirs command
No options specified
Display only those directories that are mapped through the current client view.
Include only those directories that contain files on the current client workspace’s p4 have list.
Include subdirectories that contain only deleted files. By default, these directories are not displayed.
Ignore the case of the directory argument when listing directories in a case-sensitive server.
Subdirectory under a requested depot path
The directory name
Private constructor for serialization
Format this record for display in the debugger
Summary of this revision
Options for the p4 edit command
No options specified
Keep existing workspace files; mark the file as open for edit even if the file is not in the client view.
Preview which files would be opened for edit, without actually changing any files or metadata.
Information about a file opened for edit
Path to the file in the depot
Path to the file in the workspace
The working revision number of the file that was synced
Action taken when syncing the file
Type of the file
Private constructor for serialization
Format this record for display in the debugger
Summary of this revision
Actions applied to a file in a particular revision
The file was added
The file has been edited
The file was deleted
The file was branched from elsewhere in the depot
The file at this path was added as part of a move from another location
The file at this path was deleted as part of a move into another location
The file was merged with another file in the depot
The file was purged from the server
The file was archived
Unknown
Options for the filelog command
No options
Display file content history instead of file name history.
Follow file history across branches.
List long output, with the full text of each changelist description.
List long output, with the full text of each changelist description truncated at 250 characters.
When used with the ContentHistory option, do not follow content of promoted task streams.
Display a shortened form of output by ignoring non-contributory integrations
Record output by the filelog command
Path to the file in the depot
Revisions of this file
Private constructor for serialization
Constructor
Path to the file in the depot
Revisions of this file
Format this record for display in the debugger
Summary of this revision
Options for the p4 files command
Default options
For each file, list all revisions within a specified revision range, rather than only the highest revision in the range.
Limit output to files in archive depots.
Exclude deleted, purged, or archived files; the files that remain are those available for syncing or integration.
Ignore the case of the file argument when listing files in a case sensitive server.
Record returned by the p4 files command
Path to the file in the depot
File revision number
Changelist number that the file was modified in
The action performed on this file
The file type after this change
Modification time (the time that the file was last modified on the client before submit), if in depot.
Base file type
Text file
Non-text file
Symbolic link
Multi-forked Macintosh file
Macintosh resource fork
Unicode file
Unicode file, encoded as UTF-16
Unicode file, encoded as UTF-8
Modifiers on top of the base filetype
File is always writable on the client
Executable bit set on client
RCS keyword expansion
Old-style keyword expansion
Exclusive open (locking)
Server stores the full compressed version of each file revision
Server stores deltas in RCS format
Server stores full file per revision, uncompressed
Preserve original modtime
Archive trigger required
Indicates the type of a file
Size of the object when serialized to memory
Mask for the base bits
Mask for the modifiers
Array of file type bases, with order matching
Encoded value of the filetype
Base file type
File type modifiers
Number of revisions to be stored
Constructor
The encoded value
Constructor
Base file type
File type modifiers
Number of revisions to store
Parse a string as a filetype
Try to parse a utf8 string as a filetype
Try to parse a utf8 string as a filetype base
Try to parse modifiers from a utf8 string
Compares two filetypes for equality
Compares two filetypes for equality
Extension methods for file types
Constructor for reading a file info from disk
Binary reader to read data from
Save the file info to disk
Writer to output to
The file type to serialize
Options for the Fstat command
No options specified
For scripting purposes, report file information on a list of valid file arguments in full depot syntax with a valid revision number.
Output all revisions for the given files, suppressing the other[...] and resolve[...] fields.
Output a fileSize field displaying the length of the file and a digest field for each revision.
Display the clientFile in Perforce syntax, as opposed to local syntax.
Display pending integration record data for files open in the current workspace.
Shorten output by excluding client workspace data (for instance, the clientFile field).
Sort the output in reverse order.
Limit output to files mapped into the current workspace.
Limit output to files on your have list; that is, to files synced to the current workspace.
Limit output to files opened at revisions not at the head revision.
Limit output to open files in the current workspace.
Limit output to open files that have been resolved.
Limit output to shelved files.
Limit output to open files that are unresolved.
Sort by date.
Sort by have revision.
Sort by head revision.
Sort by file size.
Sort by file type.
Include files in the unload depot when displaying data.
Record returned by the fstat command
Depot path to file
Local path to file (in local syntax by default, or in Perforce syntax with the FStatOptions.ClientFileInPerforceSyntax option)
For move operations, shows the counterpart file
Local path to file
Set if the file is open for add and it is mapped to current client workspace
Set if file is shelved
Action taken at head revision, if in depot
Head revision type, if in depot
Head revision changelist time, if in depot.
Revision for opened files
Head revision number, if in depot
Head revision changelist number, if in depot
Head revision modification time (the time that the file was last modified on the client before submit), if in depot.
Head revision of moved file
Revision last synced to workspace, if on workspace
Changelist description (if using -e changelist and if the file was part of changelist)
MD5 digest of a file (requires -Ol option)
File length in bytes (requires -Ol option)
Open action, if opened in your workspace
Open type, if opened in your workspace
User who opened the file, if opens
Open changelist number, if opened in your workspace
Summarize this record for display in the debugger
Formatted record
Options for the GetChange command (p4 change -o)
No options are specified
If a changelist was renumbered on submit, and you know only the original changelist number, use OriginalChangeNumber and the original changelist number to view or edit the changelist.
Record returned by the have command
Depot path to file
Client path to file
Local path to file
Revision of the file on the client
Time that the file was synced (local timestamp?)
Options for the p4 info command
No addiional options
Shortened output; exclude information that requires a database lookup.
Contains information about the current client and server configuration
The current user according to the Perforce environment
The current client
The current host
Root directory for the current client
Selected stream in the current client
Address of the Perforce server
Date and time on the server
Case handling setting on the server
Whether the server is case sensitive
How to compare paths on this server
How to compare paths on this server
How to compare paths on this server
List of services provided by this server
The server unique id
Timezone offset from UTC, in seconds
Describes the action performed by the user when resolving the integration
file did not previously exist; it was created as a copy of partner-file
partner-file did not previously exist; it was created as a copy of file.
file was integrated from partner-file, accepting merge.
file was integrated into partner-file, accepting merge.
file was integrated from partner-file, accepting theirs and deleting the original.
file was integrated into partner-file, accepting theirs and creating partner-file if it did not previously exist.
file was integrated from partner-file, accepting theirs.
file was integrated into partner-file, accepting theirs.
file was integrated from partner-file, accepting yours.
file was integrated into partner-file, accepting yours.
file was integrated from partner-file, and partner-file had been previously deleted.
file was integrated into partner-file, and file had been previously deleted.
file was integrated from partner-file, and file was edited within the p4 resolve process.
file was integrated into partner-file, and partner-file was reopened for edit before submission.
file was integrated from a deleted partner-file, and partner-file was reopened for add (that is, someone restored a deleted file by syncing back to a pre-deleted revision and adding the file).
file was integrated into previously nonexistent partner-file, and partner-file was reopened for add before submission.
The resulting revision has "undid" the edited changes (content and history) from the previously submitted revision(s)
The previous revision(s) have been "undone by" the resulting revision, known as the "undone" revision.
Stores integration information for a file revision
The integration action performed for this file
The partner file for this integration
Min revision of the partner file for this integration
Max revision of the partner file for this integration
Private constructor for serialization
Summarize this record for display in the debugger
Formatted integration record
Options for the login command
No options specified
Obtain a ticket that is valid for all IP addresses.
Display the ticket, rather than storing it in the local ticket file.
Display the status of the current ticket, if one exists.
Use with -a to display status for all hosts, or with -h host to display status for a specfic host.
Users with super access can provide a username argument to display the status of that username's ticket.
Information about the logged in user
The current user according to the Perforce environment
The ticket created for the user. Set only if is set.
Time at which the current ticket expires
Method by which the current user was authorized
Options for the merge command
No options
Preview the merge
Forces the operation
Performs the merge with files only
Performs the merge as a stream spec
Use stream based merging
Revere the mapping direction
Treat the from path as the source
Response from a merge
The file being merged from
The starting revision, as an integer (null if 'none')
The first revision being merged (or 'none')
The last revision being merged
Options for the p4 edit command
No options specified
Keep existing workspace files; mark the file as open for edit even if the file is not in the client view.
Rename existing files without altering content or type to a new target.
Preview which files would be opened for edit, without actually changing any files or metadata.
Information about a file opened for move
Path to the file in the depot
Path to the file in the workspace
The working revision number of the file that was synced
Action taken when syncing the file
Type of the file
Private constructor for serialization
Format this record for display in the debugger
Summary of this revision
Options for the p4 opened command
No options specified
List open files in all client workspaces
Short output; do not output the revision number or file type. This option is more efficient, particularly when using the -a (all-workspaces) option at large sites.
Record returned by the opened command
The stream spec opened for edit
Depot path to file. May be unset if this record describes a stream spec.
Client path to file (not returned if OpenedOptions.ShortOutput is set)
For a move action (either move/add or move/delete) indicates the counterpart depot path
The revision of the file (not returned if OpenedOptions.ShortOutput is set)
The synced revision of the file (may be 'none' for adds) (not returned if OpenedOptions.ShortOutput is set)
Open action, if opened in your workspace
Change containing the open file
New filetype for the file
User with the file open
Client with the file open
Record containing information about a printed file
Path to the file in the depot
Revision number of the file
Change number of the file
Last action to the file
File type
Submit time of the file
Size of the file in bytes
Information about a printed file, with its data
The type of data
Data for the file
Options for the p4 reconcile command
No options specified
Find files in the client workspace that have been modified outside of Perforce, and open them for edit.
Find files in the client workspace that are not under Perforce control and open them for add.
Find files missing from the client workspace, but present on the server; open these files for delete, but only if these files are in the user's have list.
Preview which files would be opened for add, without actually changing any files or metadata.
Add filenames that contain special (wildcard) characters.
Do not perform any ignore checking.
Display output in local file syntax with relative paths, similar to the workspace-centric view of p4 status.
use file modification time before digest to optimize
Information about a reconciled file
Path to the file in the depot
Path to the file in the workspace
The working revision number of the file that was synced
Action taken when syncing the file
Type of the file
Private constructor for serialization
Format this record for display in the debugger
Summary of this revision
Record returned from a reopen command
Options for the p4 reshelve command
No options specified
When the same file already exists in the target changelist, force the overwriting of it.
Promote the new or target changelist where it can be accessed by other edge servers participating in the multi-server configuration. Once a shelved change has been promoted, all subsequent local modifications to the shelf are also pushed to the commit server and remain until the shelf is deleted.
Options for the p4 resolve command
No options specified
Automatically accept the Perforce-recommended file revision.
Accept Yours, ignore theirs.
Accept Theirs.
If either yours or theirs is different from base, (and the changes are in common) accept that revision. If both are different from base, skip this file.
Automatically accept the Perforce-recommended file revision.
Ignore whitespace-only changes (for instance, a tab replaced by eight spaces)
Ignore whitespace altogether (for instance, deletion of tabs or other whitespace)
Ignore differences in line-ending convention
Allow already resolved, but not yet submitted, files to be resolved again.
List the files that need resolving without actually performing the resolve.
Information about a resolved file
Path to the file in the workspace
Path to the depot file that needs to be resolved
Target file for the resolve
How the file was resolved
Start range of changes to be resolved
Ending range of changes to be resolved
The type of resolve to perform
For content resolves, the type of resolve to be performed
Private constructor for serialization
Format this record for display in the debugger
Summary of this revision
Options for the revert command
No options specified
Revert only those files that haven’t changed (in terms of content or filetype) since they were opened.
Keep workspace files; the file(s) are removed from any changelists and Perforce records that the files as being no longer open, but the file(s) are unchanged in the client workspace.
List the files that would be reverted without actually performing the revert.
Files that are open for add are to be deleted (wiped) from the workspace when reverted.
Information about a reverted file
Path to the file in the depot
Path to the file in the workspace
The revision number that is now in the workspace
The previous action that the file was opened as
Action taken to revert the file
Private constructor for serialization
Format this record for display in the debugger
Summary of this revert record
Stores a revision record for a file
The revision number of this file
The changelist responsible for this revision of the file
Action performed to the file in this revision
Type of the file
Timestamp of this modification
Author of the changelist
Client that submitted this changelist
Size of the file, or -1 if not specified
Digest of the file, or null if not specified
Description of this changelist
Integration records for this revision
Private constructor for serialization
Format this record for display in the debugger
Summary of this revision
Represents a Perforce clientspec
The server id
The server type
The P4NAME used by this server (optional).
The P4PORT used by this server (optional).
Options for the p4 shelve command
No options specified
Only shelve files that have changed
Force the overwriting of any existing shelved files in a pending changelist with the contents of their client workspace copies.
Contains information about a shelved file
The changelist containing the shelved file
Path to the file in the depot
The revision number of the file that was shelved
The action to be applied to the file
Private constructor for serialization
Format this record for display in the debugger
Summary of this revision
Options for the sizes command
No options are set
For each file, list all revisions within a specified revision range, rather than only the highest revision in the range.
Display files in archive depots.
Calculate the sum of the file sizes for the specified file argument.
Display size information for shelved files only. If you use this option, revision specifications are not permitted.
When calculating size information, exclude lazy copies.
Record returned by the sizes command
Depot path to file
Revision for opened file(s)
Size for file(s)
Count of file(s)
Options for a stream
No options are set
Enable other users' ability to edit or delete the stream. If locked, the stream specification cannot be deleted, and only its owner can modify it.
Disable other users' ability to edit or delete the stream. If locked, the stream specification cannot be deleted, and only its owner can modify it.
Specifies that all users can submit changes to the stream.
Specifies that only the owner of the stream can submit changes to the stream.
Specifies whether integrations from the stream to its parent are expected.
Specifies whether integrations from the stream to its parent are expected.
Specifies whether integrations to the stream from its parent are expected.
Specifies whether integrations to the stream from its parent are expected.
Specifies whether the merge flow is restricted or whether merge is permitted from any other stream.
Specifies whether the merge flow is restricted or whether merge is permitted from any other stream.
Represents a Perforce stream spec
The stream path
The stream name
The Perforce user name of the user who owns the stream.
The date the stream specification was last modified.
The date and time that the stream was last used in any way.
The parent stream
The stream type
A textual description of the stream.
Options for this stream
Parent view
List of paths in the stream spec
Computed view for the stream
Specific changelists to import
Private constructor for serialization
Constructor
Stream
Owner
Name of the stream
Parent stream
Stream type
Parent view
List of paths in the stream spec
Options for a stream definition
The stream is locked
The stream is unlocked
Only the owner may submit to the stream
Anyone may submit to the stream
Integrations from this stream to its parent are expected
Integrations from this stream from its parent are expected
Integrations from this stream from its parent are expected
Integrations from this stream from its parent are expected
Undocumented?
Undocumented?
Contains information about a stream, as returned by the 'p4 streams' command
Path to the stream
Last time the stream definition was updated
Last time the stream definition was accessed
Owner of this stream
Name of the stream. This may be modified after the stream is initially created, but it's underlying depot path will not change.
The parent stream
Type of the stream
User supplied description of the stream
Options for the stream definition
Whether this stream is more stable than the parent stream
Whether changes from this stream flow to the parent stream
Whether changes from this stream flow from the parent stream
The mainline branch associated with this stream
Private constructor for serialization
Summarize this record for display in the debugger
Formatted stream information
Type of a Perforce stream
A mainline stream
A development stream
A release stream
A virtual stream
A task stream
Options for the 'submit' command
No options specified
Reopen files for edit in the default changelist after submission.
All open files (with or without changes) are submitted to the depot. This is the default behavior of Helix Server.
Only those files with content or type changes are submitted to the depot. Unchanged files are reverted.
Only those files with content or type changes are submitted to the depot. Any unchanged files are moved to the default changelist.
Contains information about a submitted changelist
Original changelist number
Submitted changelist number
Merge another submit record into this one. Perforce outputs multiple records for a submit command, so we merge them together for convenience.
Format this record for display in the debugger
Summary of this revision
Options for the p4 client -s command
No options specified
Ignore files which are open for edit
Action performed to the file during a sync
Unknown value
The file was added during the sync
The file was updated during the sync
The file was deleted during the sync
Options for the p4 sync command
No options specified
Force the sync. Perforce performs the sync even if the client workspace already has the file at the specified revision. If the file is writable, it is overwritten.
Keep existing workspace files; update the have list without updating the client workspace.
For scripting purposes, perform the sync on a list of valid file arguments in full depot syntax with a valid revision number.
Preview mode: Display the results of the sync without actually performing the sync.
Preview mode: Display a summary of the expected network traffic associated with a sync, without performing the sync.
Populate a client workspace, but do not update the have list. Any file that is already synced or opened is bypassed with a warning message.
Reopen files that are mapped to new locations in the depot, in the new location.
Safe sync: Compare the content in your client workspace against what was last synced.
Information about a synced file
Path to the file in the depot
Path to the file in the workspace. Note: despite being a property called 'clientFile', this is not in client syntax.
The revision number of the file that was synced
Action taken when syncing the file
Size of the file
Stores the total size of all files that are being synced (only set for the first sync record)
Stores the total number of files that will be synced (only set for the first sync record)
Change that modified the file
Information about a sync operation
The total size of all files synced
The total number of files synced
The changelist that was synced to
Information about a file opened for Undo
Path to the file in the depot
Path to the file in the workspace
The working revision number of the file that was synced
Action taken when syncing the file
Type of the file
Private constructor for serialization
Format this record for display in the debugger
Summary of this revision
Options for the p4 unshelve command
No options specified
Force the overwriting of writable (but unopened) files during the unshelve operation.
Preview the results of the unshelve operation without actually restoring the files to your workspace.
Information about an unshelved file
Path to the file in the depot
The revision number of the file
Open action for the file
Private constructor for serialization
Format this record for display in the debugger
Summary of this revision
Options for the UpdateChange command
No options are specified
Allows the description, modification date, or user of a submitted changelist to be edited. Editing a submitted changelist requires admin or super access.
Update a submitted changelist. Only the Jobs:, Description:, or Type: fields can be updated, and only the submitter of the changelist can update the changelist.
Contains information about a Perforce user
The name for the user
Registered email address for reviews
Last time the user's information was updated
Last time the user's information was accessed
The user's full name
Paths which the user is watching
The type of user
Method used to authenticate
Private constructor for serialization
Summarize this record for display in the debugger
Formatted record
Options for the p4 users command
No options specified
Include service users in list.
On replica servers, only user information from the master server are reported.
Login information: includes time of last password change and login ticket expiry, if applicable. You must be a Helix server superuser to use this option.
On replica servers, only users who have used this replica server are reported.
Contains information about a Perforce user
The name for the user
Registered email address for reviews
Last time the user's information was updated
Last time the user's information was accessed
The user's full name
The type of user
Contains information about a file's location in the workspace
Path to the file in the depot
Path to the file in client syntax
Path to the file on dist
Indicates that the given file or path is being unmapped from the workspace
Private constructor for serialization
Summarize this record for display in the debugger
Formatted record