1.\" Copyright (c) 2007 Joseph Koshy. All rights reserved. 2.\" 3.\" Redistribution and use in source and binary forms, with or without 4.\" modification, are permitted provided that the following conditions 5.\" are met: 6.\" 1. Redistributions of source code must retain the above copyright 7.\" notice, this list of conditions and the following disclaimer. 8.\" 2. Redistributions in binary form must reproduce the above copyright 9.\" notice, this list of conditions and the following disclaimer in the 10.\" documentation and/or other materials provided with the distribution. 11.\" 12.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 13.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 14.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 15.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 16.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 17.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 18.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 19.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 20.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 21.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 22.\" SUCH DAMAGE. 23.\" 24.Dd November 23, 2007 25.Dt PMC_EVENT_NAMES_OF_CLASS 3 26.Os 27.Sh NAME 28.Nm pmc_event_names_of_class 29.Nd return a list of event names supported by a PMC class 30.Sh LIBRARY 31.Lb libpmc 32.Sh SYNOPSIS 33.In pmc.h 34.Ft int 35.Fo pmc_event_names_of_class 36.Fa "enum pmc_class cl" 37.Fa "const char ***eventnames" 38.Fa "int *nevents" 39.Fc 40.Sh DESCRIPTION 41Function 42.Fn pmc_event_names_of_class 43retrieves the hardware event names supported by the class of PMC hardware 44specified by argument 45.Fa cl . 46.Pp 47It returns an array of 48.Vt "const char *" 49pointers to names of events supported by the specified class of PMC 50hardware. 51The location pointed to by argument 52.Fa nevents 53is set to the number of event names returned. 54.Pp 55The returned array is allocated using 56.Xr malloc 3 . 57.Sh RETURN VALUES 58.Rv -std pmc_event_names_of_class 59.Sh ERRORS 60A call to 61.Fn pmc_event_names_of_class 62may fail with the following errors: 63.Bl -tag -width Er 64.It Bq Er EINVAL 65Argument 66.Fa cl 67was invalid. 68.It Bq Er ENOMEM 69Allocation of a memory area to hold the result failed. 70.El 71.Sh SEE ALSO 72.Xr pmc 3 , 73.Xr hwpmc 4 74