Home > Working with SGWorld > ProjectTree (IProjectTree6) > IsLocked

IsLocked

This method returns whether a group is locked, or not.

 

JavaScript

 

IsLocked(

      ItemID)

 

C#

 

bool IsLocked(

      int ItemID)

 

C++

 

HRESULT IsLocked(

      LONG_PTR ItemID,

      VARIANT_BOOL * pVal) 

Parameters:

ItemID

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

Can not use tree root for this operation

TE_E_INFOTREE_ITEMISGROUP

ItemID is a group so an object cannot be retrieved.