guides:programming:programmers_reference_manual:setdescription

SETDESCRIPTION Method

Method for changing an entity's description in the repository.

retval = Repository('SETDESCRIPTION', entID)

The SETDESCRIPTION method has the following parameters.

ParameterDescription
Message'SETDESCRIPTION'
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.
param1new description for the entity

Null in all cases.

Note: Always call the Get_Status function after calling Repository.

Repository() function, GETDESCRIPTION Method, Get_Repos_Entities(). Also, Stored Procedures chapter in the Guide to Application Development.

/* Change the description for the for the CENTERWINDOW stored procedure */

Declare Function Repository, Get_Status

AppID = @APPID<1>  ;* current application

TypeID = "STPROCEXE"  ;* OpenInsight stored procedure executable

ClassID = ""  ;* Not Applicable

Stored_Proc_Name = 'CENTERWINDOW'

NewDescription = 'This is a new description set by calling the SETDESCRIPTION method.'

entid = AppID : '*' : TypeID : '*' : ClassID : '*' : Stored_Proc_Name
 

result = Repository("SETDESCRIPTION", entid, NewDescription)

/* result is null, need to check for errors */

If Get_Status(ErrCode) then

  call msg(@window, 'SETDESCRIPTION error ' : ErrCode : '.')

  return 1

end
  • guides/programming/programmers_reference_manual/setdescription.txt
  • Last modified: 2024/06/19 20:20
  • by 127.0.0.1