Fetch a form object from Perforce.

Namespace:  P4API
Assembly:  p4api (in p4api)
Version: 1.0.0.0 (1.0.0)

Syntax

C#
public P4Form Fetch_Form(
	string FormCommand,
	params string[] Args
)

Parameters

FormCommand
Type: System..::.String
The form command.
Args
Type: array<System..::.String>[]()[]
The args.

Return Value

A Form object. The fields of the form can be read or updated. If you update a filed, you can save it with Save_Form.

Remarks

Forms are the things that pop-up in an editor when run from a command line. In P4.Net (and most other Perforce APIs), you do not need to parse/format the text manually. Instead, you can get/set the fields using the Fields and ArrayFields collections. The following is a list of common form commands:
  • client
  • branch
  • label
  • job
  • user
  • group
  • protect
  • triggers
  • branch
    • When fetching or saving a form, do not use the '-o' and '-i' flags. P4.Net will automatically include them.

    See Also