EnumProhibitConnections

Returns information on the applications, application servers, and users for which connections have been disabled on a given cluster. The information is returned in arrays that have a one-to-one correspondence.

Syntax

<HsxClient>.EnumProhibitConnections bstrClusterName, pvaravbAllApps, pvarabstrAppNames, pvaravbAllServers, pvarabstrServerNames, pvaravbAllUsers, pvaralActivityUserIDs, pvaralActivityUserNames

Argument

Description

bstrClusterName

String (ByVal). The name of the cluster.

pvaravbAllApps

Variant array. Indicates whether connections are disabled for all applications. Array items can contain 0 or -1:

  • -1 indicates connections to all applications are disabled.

  • 0 indicates that only connections to the application returned by the corresponding pvarabstrAppNames argument’s array item are disabled.

The array is returned as a Long subtype.

pvarabstrAppNames

Variant array. Returns the application names for which connections are disabled. Application names are returned only when the corresponding pvaravbAllApps argument’s array item contains 0.

Note:

If the corresponding pvaravbAllApps argument’s array item contains -1, this array item contains the string “AllApps”.

The array is returned as a String subtype.

pvaravbAllServers

Variant array. Indicates whether connections are disabled for all application servers. Array items can contain 0 or -1:

  • -1 indicates connections to all application servers are disabled.

  • 0 indicates that only connections to the application server returned by the corresponding pvarabstrServerNames argument’s array item are disabled.

The array is returned as a Long subtype.

pvarabstrServerNames

Variant array. Returns the application server names for which connections are disabled. Application server names are returned only when the corresponding pvaravbAllServers argument’s array item contains 0.

Note:

If the corresponding pvaravbAllServers argument’s array item contains -1, this array item contains the string “AllServers”.

The array is returned as a String subtype.

pvaravbAllUsers

Variant array. Indicates whether connections are disabled for all users. Array items can contain 0 or -1:

  • -1 indicates connections for all users are disabled.

  • 0 indicates that only connections for the user represented by the corresponding pvaralActivityUserIDs and pvaralActivityUserNames arguments’ array items are disabled.

The array is returned as a Long subtype.

pvaralActivityUserIDs

Variant array. Returns the activity user IDs of the users for whom connections are disabled. Valid IDs are returned only when the corresponding pvaravbAllUsers argument’s array item contains 0.

Note:

If the corresponding pvaravbAllUsers argument’s array item contains -1, this array item contains -1.

The array is returned as a Long subtype.

pvaralActivityUserNames

Variant array. Returns the usernames of the users for whom connections are disabled. Usernames are returned only when the corresponding pvaravbAllUsers argument’s array item contains 0.

Note:

If the corresponding pvaravbAllUsers argument’s array item contains -1, this array item contains an empty string.

The array is returned as a String subtype.