Determines if the Perforce connection is valid.
Namespace:
P4APIAssembly: p4api (in p4api)
Version: 1.0.0.0 (1.0.0)
Syntax
Parameters
- checkLogin
- Type: System..::.Boolean
if set to true it will check if the user is logged in.
- checkClient
- Type: System..::.Boolean
if set to true it will verify the client exists.
Return Value
true if the connection is valid; otherwise, false.Remarks
IsValidConnection performs the following 3 checks (depending on the arguments passed).
Runs p4 info, and verifies the server is valid. If checkClient is true, verifies that p4 info returns a clientName that is not "*unknown*. If checkLogin is true, verifies that p4 login -s does not have errors.