• <GetStart>
  • CSPro User's Guide
    • The CSPro System
    • Data Dictionary Module
    • The CSPro Language
    • Data Entry Module
    • Batch Editing Applications
    • Tabulation Applications
    • Data Sources
    • CSPro Statements and Functions
      • Statement Format Symbols
      • Alphabetical List of Functions and Statements
      • List of Reserved Words
      • Deprecated Features
      • Declaration Statements
      • Symbol Functions
      • Item Functions
      • Array Object
      • Audio Object
      • Barcode and QR Codes
      • Case Object
      • Document Object
      • File Object
      • Freq Object
      • Geometry Object
      • HashMap Object
        • HashMap Statement
        • HashMap.getKeys Function
        • HashMap.contains Function
        • HashMap.length Function
        • HashMap.remove Function
        • HashMap.clear Function
      • Image Object
      • List Object
      • Map Object
      • Path
      • Pff Object
      • SystemApp Object
      • ValueSet Object
      • Program Control Statements
      • Assignment Statements
      • Data Entry Statements and Functions
      • Batch Edit Statements
      • Numeric Functions
      • String Functions
      • Multiple Occurrence Functions
      • General Functions
      • Date and Time Functions
      • External File Functions
      • Synchronization Functions
    • Templated Reporting System
    • HTML and JavaScript Integration
    • Action Invoker
    • Appendix
  • <CSEntry>
  • <CSBatch>
  • <CSTab>
  • <DataViewer>
  • <TextView>
  • <TblView>
  • <CSFreq>
  • <CSDeploy>
  • <CSPack>
  • <CSDiff>
  • <CSConcat>
  • <Excel2CSPro>
  • <CSExport>
  • <CSIndex>
  • <CSReFmt>
  • <CSSort>
  • <ParadataConcat>
  • <ParadataViewer>
  • <CSCode>
  • <CSDocument>
  • <CSView>
  • <CSWeb>

HashMap.getKeys Function

Format
i = hashmap_name.getKeys(list_name ʃ, key_value1, ..., key_valueNʅ);
Description
The HashMap.getKeys function fills a List with the keys at a specific location in the HashMap. Each key_value argument must be a numeric or string expression matching the type specified when declaring the HashMap. If no arguments are provided, the first-dimension keys are returned; if one argument is provided, the second-dimension keys are returned; and so on.
The argument list_name is a numeric or string List whose contents will be cleared and then filled with the HashMap's keys. The type of the List must correspond to the type of keys at the specified location. If the dimension type is numeric, then the List must be a numeric List. If the dimension type is string or all, then the List must be a string List. In the case of all, any numeric values added as keys to the HashMap will be converted to strings before being inserted in the string List.
Return Value
The function returns the number of keys added to the List.
Example
PROC GLOBAL

HashMap invalidValuesByPerson default(0);

PROC CENSUS_LEVEL

   
List string person_list;

    invalidValuesByPerson.
getKeys(person_list);

   
do numeric counter = 1 while counter <= person_list.length()
       
errmsg("%s had %d invalid values", strip(person_list(counter)),
                                           invalidValuesByPerson(person_list(counter)));
   
enddo;

    invalidValuesByPerson.
clear();

PROC SEX

   
if not invalueset(SEX) then
       
inc(invalidValuesByPerson(PERSON_NAME));
   
endif;

PROC AGE

   
if not invalueset(AGE) then
       
inc(invalidValuesByPerson(PERSON_NAME));
   
endif;
See also: HashMap Object, HashMap.contains Function, HashMap.length Function