IsLocked

This method checks whether or not a group is locked. IsLocked returns TRUE when the specified group is locked.  .

 

JavaScript

 

IsLocked(

       ID)

 

C#

 

bool IsLocked(

       string GroupID)

 

C++

 

HRESULT IsLocked(

       BSTR GroupID,

       VARIANT_BOOL * pVal) 

Parameters

GroupID

The ID of the group in question.

Return Value

pVal

A Boolean that indicates whether or not the group is locked.

Exceptions

HRESULT can return any of the values listed in the HRESULT Return Values list, as well as the following values:

TE_E_INFOTREE_PARENTNOTGROUP

The group ID entered does not represent a valid group in the Project Tree.

TE_E_INFOTREE_ITEMNOTGROUP

The item entered is not a group and therefore cannot be used as a group.

TE_E_INFOTREE_CANTUSEROOT

Cannot use Tree root for this operation

TE_E_INFOTREE_ITEMISGROUP

Item ID is a group so an object cannot be retrieved.