sa_user_defined_counter_set system procedure

sa_user_defined_counter_set ( counter_name 
[, value
[, apply_to_con
[, appy_to_db
[, apply_to_server ] ] ] ]
)

counter_name Use this VARCHAR(128) parameter to specify the name of the user-defined counter whose value you want to change. Examples of user-defined counter names are UserDefinedCounterRate01 and UserDefinedCounterRaw01.
value The amount that the user-defined counter is changed to. The default is 1.
apply_to_con Use this INT parameter to specify whether to adjust the counter value for the current connection. 0 means do not adjust the value, and 1 means adjust the value. The default is 1.
apply_to_db Use this INT parameter to specify whether to adjust the counter value for the database. 0 means do not adjust the value, and 1 means adjust the value. The default is 1.
apply_to_server Use this INT parameter to specify whether to adjust the counter value for the database server. 0 means do not adjust the value, and 1 means adjust the value. The default is 1.

The procedure returns 1 if value is defined, and 0 otherwise. The procedure returns 0 when value is not defined, and returns an error code if an error occurs. Example of errors include:

an invalid counter name
an invalid value for the apply_to_server, apply_to_db, or apply_to_con parameter.

Concurrent access to counters is applied atomically, so a counter value can be reset from multiple, concurrent requests.

DBA authority

None

The following statement sets the value of UserDefinedCounterRate01 to 0 for the current connection, database, and database server:

SELECT dbo.sa_user_defined_counter_set( 'UserDefinedCounterRate01', 0, 1, 1, 1 );

sa_user_defined_counter_set system procedure

Syntax

Arguments

Remarks

Permissions

Side effects

See also

Example