guides:programming:programmers_reference_manual:getsubkey

GETSUBKEY Method

Method for getting the "subkey" (data storage location), for entities such as documents. The subkey is found on the Entity…Properties dialog in the Repository outline.

retval = Repository('GETSUBKEY', entID)

The GETSUBKEY method has the following parameters.

ParameterDescription
Message'GETSUBKEY'
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.

The entity's sub-key.

Note: Always call the Get_Status function after calling Repository.

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

/* Get the path for the INET_INVOICE_RPT HTML document, stored in the SUB-KEY, in the result variable */

Declare Function Repository, Get_Status

AppID = @APPID<1>  ;* current application

TypeID = "DOC"  ;* ;* document type

ClassID = "HTML"  ;*  HTML class

Report_Name = 'INET_INVOICE_RPT'

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

 

result = Repository("GETSUBKEY", entid)

/*  result now contains the path to the INET_INVOICE_RPT HTML report. */

If Get_Status(ErrCode) then

  call msg(@window, 'Error Message returned: ' : ErrCode)

  return 1

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