[ Previous | Next | Table of Contents | Index | Library Home | Legal | Search ]

Technical Reference: Base Operating System and Extensions , Volume 2


slk_label Subroutine

Purpose

Returns the label name for a specified soft label.

Library

Curses Library (libcurses.a)

Syntax

#include <curses.h>


char *slk_label( LabNum)
int LabNum;

Description

The slk_label subroutine returns the label name for a specified soft function-key label. These labels appear at the bottom of the screen and give applications, such as editors, a more user-friendly look. The slk_label subroutine returns the name in the format it was in when passed to the slk_set subroutine. If the name was justified by the slk_set subroutine, the justification is removed.

Parameters


LabNum Specifies the label number. This parameter must be in the range 1 to 8.

Example

To obtain the label name for soft label 3, use:

char *label_name;

label_name = slk_label(3);

Return Values


NULL Indicates a label number that is not valid or a label number not set with the slk_set subroutine.
OK Indicates that the label name was successfully retrieved.

Implementation Specifics

This subroutine is part of Base Operating System (BOS) Runtime.

Related Information

The slk_init (slk_init Subroutine) subroutine and slk_set (slk_set Subroutine) subroutine.

Curses Overview for Programming, List of Curses Subroutines, Manipulating Video Attributes in AIX 5L Version 5.1 General Programming Concepts: Writing and Debugging Programs.


[ Previous | Next | Table of Contents | Index | Library Home | Legal | Search ]