Description

Method for getting the entity's description information.

Syntax

retval = Repository("GETDESCRIPTION" entID)

Parameters

The GETDESCRIPTION method has the following parameters.

ParameterDescription
Message"GETDESCRIPTION"
entIDentID consists of four elements, which are '*' (asterisk) delimited:
 
  • Application name
  • Type ID
  • Class ID
  • Entity name
 Methods are executed as follows: if class specific, execute at the class level; if type specific, execute at the type level; otherwise, execute the method.

Returns

The description for the entity, as stored in SYSREPOS.

Note: Always call the Get_Status function after calling Repository.

See also

Repository() functionSETDESCRIPTION MethodGet_Repos_Entities().

Example

/* Read the description of the CENTERWINDOW stored procedure into the variable called result */
Declare Function Get_Repos_Entities, Repository, Get_Status
AppID = @APPID<1>  ;* current application
TypeID = "STPROC"  ;* OpenInsight stored procedures
ClassID = ""  ;* Not Applicable
Stored_Proc_Name = 'CENTERWINDOW'
entid = AppID : '*' : TypeID : '*' : ClassID : '*' : Stored_Proc_Name
result = Repository("GETDESCRIPTION", entid)
/*  result now contains the description information of CENTERWINDOW */
If Get_Status(ErrCode) then
  call msg(@window, 'Error Message returned: ' : ErrCode)
end
  • No labels