Initializing help system before first use

ins~getscalar

Purpose
Create an ins~entityfetch record for fetching a scalar entity.
Synopsis
function getscalar(entity:text, dst:any):ins~entityfetch
Arguments
entity 
The name of the entity to fetch
dst 
A reference to a variable that will be populated by the value of the entity. May be a reference to a scalar or an array.
Return value
A value that can be passed to ins~getscendata to read the entity into the given reference.
Example 
declarations
  SCENARIO_ID='2926e9a1-9568-4116-84ed-2e75190bc651'
  maxprofit: real
end-declarations
ins~getscendata(SCENARIO_ID, [ ins~getscalar('maxProfit', ->maxprofit) ] )
if ins~haserror then
  writeln_('Error: ',ins~getlasterror)
else
  writeln('Maximum profit: ',maxprofit)
end-if
Example of fetching a scalar entity into a variable reference. 
declarations
  SCENARIO_ID='2926e9a1-9568-4116-84ed-2e75190bc651'
  values: array(set of string) of real
end-declarations
ins~getscendata(SCENARIO_ID, [ ins~getscalar('maxProfit', values) ] )
if ins~haserror then
  writeln_('Error: ',ins~getlasterror)
else
  writeln('Maximum profit: ',values('maxProfit'))
end-if
Example of fetching a scalar entity into an array cell.
Further information
1. The destination may be a reference to a string, text, integer, real or boolean, or an array of one of those types or any.
2. If the scalar type does not match the type of the destination reference, the value will be converted (e.g. a real type entity would be rounded down to be stored in an integer).
3. Where the destination is a reference to an array, it must have a single index set (of type string or constant text; the fetch will insert an array cell whose index is the entity name and value is the fetched value.
4. This function cannot fail; invalid parameter values will only cause an error when the returned value is passed to ins~getscendata.
Related topics
ins~getscalars ins~getscendata

Parent Topic Reading Scenario Data

© 2001-2024 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.