SAS Component Language Dictionary

IOPTION

Returns options for index columns and key columns

Category:

SAS Table

Syntax
Details
Example
See Also

Syntax

options=IOPTION(table-id,key-name);

options

contains options for the specified index key-name, separated by a blank:

MISSING: The index can contain missing values.
NOMISS: The index does not contain missing values.
NONUNIQUE: The index can contain non-unique values.
UNIQUE: The index contains only unique values.

Type: Character

table-id

is the identifier that was assigned when the table was opened. If table-id is invalid, the program halts.

Type: Numeric

key-name

is the name of an index key.

Type: Character

Details

An index is an auxiliary data structure used to speed up the selection of records that are specified by the value of a column.

You can create indexes using

the ICREATE function in SCL
the DATASETS and SQL procedures in Base SAS software
SAS/IML software
the CONTENTS function in SCL
the ACCESS procedure in SAS/ACCESS software.

When an error occurs, IOPTION returns a blank string.

Example

Return the options of the defined key index ITEMTYPE for the SAS table WORK.DATAONE. If the value returned to the OPTIONS column is blank, then the message returned by the SYSMSG function is displayed on the message line.

tableid=open('work.invoice','i');
options=ioption(tableid,'itemtype');
if (options=' ') then _msg_=sysmsg();