Appendix B: Datatypes and Structures


Summary of datatypes

Table B-1 lists Monitor Client Library type constants with descriptions and their corresponding C or Open Client datatypes.

Table B-1: Summary of datatypes

Monitor Client Library datatype

Description

Corresponding C or Open Client datatype

SMC_ALARM_ACTION_TYPE

Specifies the type of action to take when an alarm is triggered

None

SMC_ALARM_ID

Alarm identifier

size_t

SMC_ALARM_IDP

Pointer to alarm identifier

size_t*

SMC_BOOL

Boolean

int

SMC_CHAR

Character

char

SMC_CHARP

Character pointer

char*

SMC_CHARPP

Pointer to character pointer

char**

SMC_CCHARP

Constant character pointer

CS_CONST char*

SMC_CLOSE_TYPE

Specifies an option when closing a Adaptive Server Enterprise Monitor connection

None

SMC_COMMAND_ID

Command identifier

size_t

SMC_COMMAND_IDP

Pointer to command identifier

size_t*

SMC_CONNECT_ID

Connection identifier

size_t

SMC_CONNECT_IDP

Pointer to connection identifier

size_t*

SMC_DATETIME

Date and time

CS_DATETIME

SMC_DATAITEM_NAME

Identifies a particular piece of performance data that Monitor Client Library is to obtain

None

SMC_DATAITEM_NAMEP

Pointer to SMC_DATAITEM_NAME

None

SMC_DATAITEM_STATTYPE

Identifies what normalization, if any, Monitor Client Library should perform on data

None

SMC_DATAITEM_STRUCT

Identifies data that Monitor Client Library is to obtain

None

SMC_DATAITEM_STRUCTP

Pointer to SMC_DATAITEM_STRUCT

None

SMC_DATAITEM_TYPE

Identifies datatype of data that Monitor Client Library obtains

None

SMC_DATAITEM_TYPEP

Pointer to SMC_DATAITEM_TYPE

None

SMC_DOUBLE

Double precision floating point

double

SMC_DOUBLEP

Pointer to double precision

double*

SMC_ERR_SEVERITY

Indicates the degree of severity of an error

None

SMC_FILTER_ID

Filter identifier

size_t

SMC_FILTER_IDP

Pointer to filter identifier

size_t*

SMC_FILTER_TYPE

Specifies the type of filter to create with smc_create_filter

None

SMC_HS_ESTIM_OPT

Specifies whether, in playback of historical performance data, to authorize estimation of data that cannot be calculated reliably from the available recorded data

None

SMC_HS_MISSDATA_OPT

Specifies whether, in playback of historical performance data, a sample should be returned for a period of time for which no data is available

None

SMC_HS_PLAYBACK_OPT

Specifies whether playback of historical performance data should be normalized or summarized or both

None

SMC_HS_SESS_DELETE_OPT

Specifies whether to delete data files associated with a Historical Server session

None

SMC_HS_SESS_ERR_OPT

Specifies whether a recording session should continue after an error

None

SMC_HS_SESS_PROT_LEVEL

Specifies whether the data in a recording session should be accessible to other users

None

SMC_HS_SESS_SCRIPT_OPT

Specifies whether to create a script to create tables corresponding to the views in a recording session

None

SMC_HS_TARGET_OPT

Specifies whether playback of historical performance data should be sent to the client application, or used to create a new session

None

SMC_INFO_TYPE

Specifies the type of information to request in a call to smc_get_command_info

None

SMC_INT

Integer

int

SMC_INTP

Pointer to integer

int*

SMC_LOCK_RESULT

Identifies the possible outcomes of a lock request

None

SMC_LOCK_RESULT_SUMMARY

Identifies the two major categories of outcomes of a lock request

None

SMC_LOCK_STATUS

Identifies the possible statuses of a lock or lock request

None

SMC_LOCK_TYPE

Identifies the granularity and exclusivity of a lock

None

SMC_LONG

Long

long

SMC_LONGP

Pointer to long

long*

SMC_OBJ_TYPE

Identifies the type of an object in an Adaptive Server database

None

SMC_PROC_STATE

Identifies the possible statuses of an Adaptive Server process

None

SMC_PROP_ACTION

Specifies the action to take in a call to smc_connect_props

None

SMC_PROP_TYPE

Specifies the property that is the object of a call to smc_connect_props

None

SMC_RETURN_CODE

Indicates whether a Monitor Client Library operation succeeded, and, if not, what error occurred

None

SMC_SERVER_MODE

Specifies whether a Adaptive Server Enterprise Monitor connection is to obtain live performance data or whether to manipulate historical data

None

SMC_SESSION_ID

Session identifier

size_t

SMC_SESSION_IDP

Pointer to session identifier

size_t*

SMC_SIZET

unsigned integer

size_t

SMC_SIZETP

Pointer to unsigned integer

size_t*

SMC_SOURCE

Indicates the software layer that detected an error

None

SMC_VALUE_UNION

Structure containing data

None

SMC_VALUE_UNIONP

Pointer to SMC_VALUE_UNION

None

SMC_VIEW_ID

View identifier

size_t

SMC_VIEW_IDP

Pointer to view identifier

size_t*

SMC_VOID

Void

void

SMC_VOIDP

Pointer to void

void*

The rest of this appendix describes individual datatypes that have no equivalent in C or Open-Client Client Library.