Content-type: text/html Man page of DXmSvnGetDisplayed

DXmSvnGetDisplayed

Section: Miscellaneous Library Functions (3X)
Index Return to Main Contents
 

NAME

DXmSvnGetDisplayed - Retrieves (returns) displayed entry numbers and related information necessary to draw a corresponding display.  

SYNOPSIS

void DXmSvnGetDisplayed( Widget widget, int *entries(), XtPointer *tags(), int *ys(), int len );
 

PARAMETERS

The identifier (widget ID) of the SVN widget. A pointer to an array of integers to receive the entry numbers of the entries being displayed. A pointer to an array of longwords to receive the application's entry_tag value for each entry displayed. If tags are not required, a Null pointer may be passed. A pointer to an array of longwords to receive the y coordinates for each entry displayed. If y coordinates are not required, a Null pointer can be passed. The number of entries allocated in the provided array.
 

DESCRIPTION

The DXmSvnGetDisplayed routine returns information about the entries that the SVN widget is currently displaying. This information can then be used to keep a simultaneous display up to date with the SVN widget window (in the case of a dialog box, for example, which might contain totals for the entries being displayed).

The application is responsible for managing the memory used to return this list of entries. As such, note the following: At the minimum, the number of entries in the array should be capable of holding at least the number of entries indicated by the value returned from the DXmSvnGetNumDisplayed routine. If there are more entries in the array than the application will need, the SVN widget will set the value for those extra entries to 0. If the capacity of the arrays passed is less than the number of selected entries, only the number of entries allocated in the provided array (the value for len) will be returned.


 

Index

NAME
SYNOPSIS
PARAMETERS
DESCRIPTION

This document was created by man2html, using the manual pages.
Time: 02:42:38 GMT, October 02, 2010