call "CBL_AUDIT_EMITTER_PROPERTY_GET" using by value flags
by reference emitter-name
by reference property-name
by reference property-vallen
by reference property-value
returning status-code
| Bit | Value | Meaning |
|---|---|---|
| 0 | 0 | Return string value. Use bit 1 to determine string terminator |
| 1 | Return integer value. Ignore bit 1. | |
| 1 | 0 | Return the value as a space-terminated string |
| 1 | Return the value as a null-terminated string | |
| 2-27 | Reserved for future use (must be 0) | |
| 28 | 0 | emitter-name is space-terminated |
| 1 | emitter-name is null-terminated | |
| 29 | 0 | property-name is space-terminated |
| 1 | property-name is null-terminated | |
| 30-31 | Reserved for future use (must be 0) |
Ignored if value is being returned as an integer.
| property-vallen | Length of returned string value in property-value buffer. Length does not include termination character.
If property-value is null, or if the specified buffer length is too small for the value to be returned, property-vallen will be set to the required buffer length. Not set if the value is being returned as an integer. |
| property-value | Buffer in which the property value is to be returned. This is either a pic x(n) field for a value being returned as a string, or a pic x(4) comp-5 field for a value being returned as an integer.
A null property-value may be specified to request that the API returns the required buffer length to hold the specified property value. |
Get two property values associated with the "AUDITFILE" emitter: one a space-terminated string value, one an integer value.
copy "mfaudit.cpy ".
01 emitter-name pic x(10) value " AUDITFILE".
01 flags pic x(4) comp-5.
01 prop-integer pic x(4) comp-5.
01 prop-len pic x(4) comp-5.
01 prop-string pic x(100).
...
compute flags = 78-AUD-FLAG-PROP-STRING-VALUE
move length of prop-string to prop-len
call "CBL_AUDIT_EMITTER_PROPERTY_GET" using
by value flags
by reference emitter-name
by reference "location "
by reference prop-len
by reference prop-string
...
compute flags = 78-AUD-FLAG-PROP-INT-VALUE
call "CBL_AUDIT_EMITTER_PROPERTY_GET" using
by value flags
by reference emitter-name
by reference "collectionsize "
by value 0
by reference prop-integer
...
Comments:
CBL_AUDIT_EMITTER_PROPERTY_GET is used to retrieve a named property value for the emitter with name emitter-name. The function would typically by used by an emitter during its initialisation to determine how it had been configured.