Measure Reference Manual

entitydesc can contain wildcards. Using a wildcard descriptor along with LIST mode is the
best way to get the records of all the instances of an entity configured on a processor. This
procedure does not use string-based fields, such as OSS pathname or program file name, for
descriptor matching. Such strings are ignored, if provided; if you need to use them, call the
MEASREADACTIVE procedure instead.
NOTE: entitydesc can be a DISKFILE, DISCOPEN, or FILE entity descriptor for ANSI SQL
objects or partitions. However, there is currently no support for ANSI SQL names or ANS UIDs
in this API, so those descriptor fields will be ignored.
buffer
output
INT .EXT:ref:*
is the destination buffer for the counter records. Counter records are written to the buffer in
DDL record format. For the DDL record definitions for each entity type, see Chapter 3: Entities
and Counters (page 136).
bufsize
input
INT(32):value
is the size in bytes of the destination buffer, buffer.
recs
output
INT .EXT:ref:1
is the number of records returned.
context
input, output
FIXED .EXT:ref:1
interacts with the value of the mode parameter to determine which records are returned.
On input, if context is -1F or 0F:
• The counter type for the entity type specified in entitydesc is searched until a counter
matches the information in entitydesc.
• If mode is READACTIVE_MANY_EXACT, one item is returned.
• If mode is READACTIVE_MANY_LIST, all items that match entitydesc are returned until
bufsize is exhausted.
• If mode is READACTIVE_MANY_CHANGED, all items that match the entitydesc are
returned, but the ERROR field in the header part of the record is updated to show whether
the record has changed since last requested. Specifically, if the record has not changed
and the style is ZMS, the 0th and 5th bits of entity.HDR.ERROR are set to 1. Otherwise,
the 5th bit is 0. If the style is Legacy, a value of -4 is returned in the entity.ERROR field
to indicate unchanged records. This Error field is part of the counter record returned (and
is specific to it). It is not related to the error values returned by this procedure.
• On successful return, the context contains information about the next entity to be
processed. It should be passed as is for the future calls in that iteration.
430 Measure Callable Procedures