pair_content Subroutine

AIX Version 4.3 Base Operating System and Extensions Technical Reference, Volume 2

pair_content Subroutine

Purpose

Returns the colors in a color pair.

Library

Curses Library (libcurses.a)

Curses Syntax

#include <curses.h>

pair_content (Pair, F, B)
short Pair;
short *F, *B;

Description

The pair_content subroutine returns the colors in a color pair. A color pair is made up of a foreground and background color. You must call the start_color subroutine before calling the pair_content subroutine.

Note: The color pair must already be initialized before calling the pair_content subroutine.

Return Values

OK	Indicates the subroutine completed successfully.
ERR	Indicates the pair has not been initialized.

Parameters

Pair	Identifies the color-pair number. The Pair parameter must be between 1 and COLORS_PAIRS-1.
F	Points to the address where the foreground color will be stored. The F parameter will be between 0 and COLORS-1.
B	Points to the address where the background color will be stored. The B parameter will be between 0 and COLORS-1.

Example

To obtain the foreground and background colors for color-pair 5 , use:

short *f, *b;
pair_content(5,f,b);

For this subroutine to succeed, you must have already initialized the color pair. The foreground and background colors will be stored at the locations pointed to by f and b.

Implementation Specifics

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

Related Information

The start_color subroutine, init_pair subroutine.

Curses Overview for Programming, List of Curses Subroutines, Manipulating Video Attributes, Working with Color in AIX Version 4.3 General Programming Concepts: Writing and Debugging Programs.