Method LoadProjectAsync

Namespace

Kepware.Api.ClientHandler

Assembly

Kepware.Api.dll

LoadProjectAsync(bool, int, CancellationToken)

Loads the project from the Kepware server. If blnLoadFullProject is true, it loads the full project, otherwise only the project properties will be returned.

public Task<Project> LoadProjectAsync(bool blnLoadFullProject = false, int projectLoadTagLimit = 0, CancellationToken cancellationToken = default)

Parameters

blnLoadFullProject bool

Indicates whether to load the full project.

projectLoadTagLimit int

The tag count threshold to determine whether to use optimized content=serialize loading or basic recursive loading when loading the full project. This is only applicable for projects loaded with the full project load option and when the JsonProjectLoad service is supported by the server.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<Project>

A task that represents the asynchronous operation. The task result contains the loaded Project.

Remarks

NOTE: When loading a full project, the project will be loaded either via the JsonProjectLoad service, an "optimized" recursion that uses the content=serialize query or a basic recurion through project tree. Putting a value for projectLoadTagLimit will override the value set in ProjectLoadTagLimit during initial client creation.