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.\" $FreeBSD$ 25.\" 26.Dd November 23, 2007 27.Dt PMC_EVENT_NAMES_OF_CLASS 3 28.Os 29.Sh NAME 30.Nm pmc_event_names_of_class 31.Nd return a list of event names supported by a PMC class 32.Sh LIBRARY 33.Lb libpmc 34.Sh SYNOPSIS 35.In pmc.h 36.Ft int 37.Fo pmc_event_names_of_class 38.Fa "enum pmc_class cl" 39.Fa "const char ***eventnames" 40.Fa "int *nevents" 41.Fc 42.Sh DESCRIPTION 43Function 44.Fn pmc_event_names_of_class 45retrieves the hardware event names supported by the class of PMC hardware 46specified by argument 47.Fa cl . 48.Pp 49It returns an array of 50.Vt "const char *" 51pointers to names of events supported by the specified class of PMC 52hardware. 53The location pointed to by argument 54.Fa nevents 55is set to the number of event names returned. 56.Pp 57The returned array is allocated using 58.Xr malloc 3 . 59.Sh RETURN VALUES 60.Rv -std pmc_event_names_of_class 61.Sh ERRORS 62A call to 63.Fn pmc_event_names_of_class 64may fail with the following errors: 65.Bl -tag -width Er 66.It Bq Er EINVAL 67Argument 68.Fa cl 69was invalid. 70.It Bq Er ENOMEM 71Allocation of a memory area to hold the result failed. 72.El 73.Sh SEE ALSO 74.Xr pmc 3 , 75.Xr hwpmc 4 76