• <Helps for GetStart>
  • CSPro User's Guide
    • The CSPro System
    • Data Dictionary Module
    • The CSPro Language
    • Data Entry Module
    • Batch Editing Applications
    • Tabulation Applications
    • CSPro Statements and Functions
      • Statement Format Symbols
      • Alphabetical List of Statements and Functions
      • List of Reserved Words
      • Deprecated Features
      • Declaration Statements
      • 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
        • Clear Function
        • Close Function
        • CountCases Function
        • DelCase Function
        • DirCreate Function
        • DirExist Function
        • DirList Function
        • FileConcat Function
        • FileCopy Function
        • FileCreate Function
        • FileEmpty Function
        • FileExist Function
        • FileDelete Function
        • FileName Function
        • FileRead Function
        • FileRename Function
        • FileSize Function
        • FileWrite Function
        • Find Function
        • Key Function
        • KeyList Function
        • LoadCase Function
        • Locate Function
        • NMembers Function
        • Open Function
        • Retrieve Function
        • Set Access Statement
        • SetFile Function
        • Set First Statement
        • Set Last Statement
        • Write Function
        • WriteCase Function
      • Synchronization Functions
    • Appendix
  • <Helps for CSEntry>
  • <Helps for CSBatch>
  • <Helps for CSTab>
  • <Helps for DataViewer>
  • <Helps for TextView>
  • <Helps for TblView>
  • <Helps for MapView>
  • <Helps for TRSWin>
  • <Helps for TRSSetup>
  • <Helps for CSFreq>
  • <Helps for CSExport>
  • <Helps for CSSort>
  • <Helps for CSReFmt>
  • <Helps for CSDiff>
  • <Helps for CSConcat>
  • <Helps for ShpToMap>
  • <Helps for CSPack>
  • <Helps for CSIndex>
  • <Helps for Excel2CSPro>
  • <Helps for CSWeb>

Key Function

Format
s = key(dictionary_name);
Description
The key function returns a string containing the key of the case currently loaded in the file referenced by dictionary_name. A dictionary key is a single string comprised of the IDs for a case.
Return Value
The function returns a string containing the key. If there has been no previous activity on the file and no key has been established, the key function returns a blank string.
Example
if key(CENSUS_DICT)[1:2] = "04" then // do not output any cases with IDs starting with 04
    skip case;
endif;
See also: KeyList Function, GetCaseLabel Function