Skip to end of metadata
Go to start of metadata

Availability

This routine is available starting with katl-commons 3.0.

Syntax

admUpdateProjectVersion(versionStruct)

Description

Updates the version of the project by the id field.

The version name of the project is unique and it has an id version that corresponds with it.

 

This routine updates only the name, description, startDate and releaseDate fields. The archived and released fields can be updated using admArchiveProjectVersion and admReleaseProjectVersion routines. Name must be unique.

Parameters

Parameter name

Type

Required

Description

 versionStructJVersionyes

Version id and the version name should have values assigned.

 

The parameter versionStruct should have the type JVersion.

Return type

string
You can safely ignore the return value of this routine.

Example

JVersion jVersion;
jVersion.id = 10201;
jVersion.name = "Version2";
jVersion.description = "This is the second version.";
jVersion.startDate = "2014-10-27";
jVersion.releaseDate = "2014-10-30";
return admUpdateProjectVersion(jVersion);


See also