NAME

PAPI_create_eventset - create an EventSet

CONTENTS

Synopsis
Description
Arguments
Return Values
Errors
Examples
Authors
Bugs
See Also

SYNOPSIS

C Interface

#include <papi.h> 

PAPI_create_eventset (int *EventSet); 

Fortran Interface

#include fpapi.h 

PAPIF_create_eventset(C_INT EventSet, C_INT check) 

DESCRIPTION

PAPI_create_eventset() creates a new EventSet pointed to by EventSet, which must be initialized to PAPI_NULL before calling this routine. The user may then add hardware events to the event set by calling PAPI_add_event (3) or similar routines.

ARGUMENTS

EventSet -- Address of an integer location to store the new EventSet handle

RETURN VALUES

On success, this function returns PAPI_OK.
On error, a non-zero error code is returned.

ERRORS

PAPI_EINVAL
  The argument handle has not been initialized to PAPI_NULL.
PAPI_ENOMEM
  Insufficient memory to complete the operation.

EXAMPLES


  int EventSet = PAPI_NULL;

if (PAPI_create_eventset(&EventSet) != PAPI_OK) handle_error(1);

/* Add Total Instructions Executed to our EventSet */

if (PAPI_add_event(EventSet, PAPI_TOT_INS) != PAPI_OK) handle_error(1);

AUTHORS

The PAPI Team. See them at the PAPI Web Site: http://icl.cs.utk.edu/projects/papi

BUGS

This function has no known bugs.

SEE ALSO

PAPI_destroy_eventset (3), PAPI_cleanup_eventset (3), PAPI_remove_event (3), PAPI_remove_events (3), PAPI_add_event (3), PAPI_add_events (3)


PAPI Programmer’s Reference PAPI_create_eventset (3) November, 2003

  Innovative Computing Laboratory
2001 R&D Winner  
Contact PAPI: papi@cs.utk.edu Computer Science Department
  University of Tennessee