Content-type: text/html Man page of DXmSvnGetHighlighted

DXmSvnGetHighlighted

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

NAME

DXmSvnGetHighlighted - Retrieves (returns) a list of entries currently highlighted by the user.  

SYNOPSIS

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

PARAMETERS

The identifier (widget ID) of the SVN widget. A pointer to an array of integers to receive the highlighted entry numbers. A pointer to an array of longwords to receive the application's entry_tag value for each highlighted entry. If tags are not required, a null pointer may be passed. An integer that represents the number of entries allocated in the provided array.
 

DESCRIPTION

The DXmSvnGetHighlighted routine returns a list of entries that are currently highlighted by the user. Make this call in your application between calls to DXmSvnDisableDisplay and DXmSvnEnableDisplay to ensure that the highlighted list is not changing.

The application is responsible for managing the memory used to return this list of highlighted entries. As such, note the following: At the minimum, the number of entries in the array should be capable of holding the number of entries indicated by the value returned from the DXmSvnGetNumHighlighted 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:09 GMT, October 02, 2010