Initializing help system before first use

ins~getscalars

Purpose
Create an ins~entityfetch record for fetching multiple scalar entities into an array.
Synopsis
function getscalars(entities:list of string, dst:any):ins~entityfetch
function getscalars(entities:list of text, dst:any):ins~entityfetch
Arguments
entities 
The names of the entities to fetch
dst 
A reference to an array into which to read the entities
Return value
A value that can be passed to ins~getscendata to read the entities into the given array.
Example 
declarations
  SCENARIO_ID='2926e9a1-9568-4116-84ed-2e75190bc651'
  values: array(set of string) of any
end-declarations
ins~getscendata(SCENARIO_ID, [ ins~getscalars(['maxProfit', 'minProfit',
   'username'], values) ] )
if ins~haserror then
  writeln_('Error: ',ins~getlasterror)
else
  writeln('Maximum profit: ', values('maxProfit'))
  writeln('Minimum profit: ', values('minProfit'))
  writeln('Username profit: ', values('username'))
end-if
Example of fetching multiple scalar entities into an array
Further information
1. The destination must be an array of string, text, integer, real, boolean, or any. The array must have a single index set of type string or constant text.
2. If the scalar type does not match the type of the array, the value will be converted (e.g. a real type entity would be rounded down to be stored in an integer).
3. Any cells in the array whose indexes don't match the fetched entities will not be affected.
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~getscalar 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.