EnumProhibitConnections

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

Tip:

To return this information for only a given server cluster, use HFMwManageApplications.EnumProhibitConnections.

Syntax

<HFMwSystemInfo>.EnumProhibitConnections pvaravarvbAllApps, pvaravarbstrAppNames, pvaravarvbAllServers, pvaravarbstrServerNames, pvaravarvbAllUsers, pvaravarlActivityUserIDs, pvaravarbstrActivityUserNames

Argument

Description

pvaravarvbAllApps

Returns an array that 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 pvaravarbstrAppNames argument’s array item are disabled.

Input/output argument.

pvaravarbstrAppNames

Returns an array containing the names of the applications for which connections are disabled. Application names are returned only when the corresponding pvaravarvbAllApps argument’s array item contains 0.

Note:

This is a 1-based array.

Note:

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

Input/output argument.

pvaravarvbAllServers

Returns an array that 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 pvaravarbstrServerNames argument’s array item are disabled.

Input/output argument.

pvaravarbstrServerNames

Returns an array containing the names of the application servers for which connections are disabled. Application server names are returned only when the corresponding pvaravarvbAllServers argument’s array item contains 0.

Note:

This is a 1-based array.

Note:

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

Input/output argument.

pvaravarvbAllUsers

Returns an array that 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 pvaravarlActivityUserIDs and pvaravarbstrActivityUserNames arguments’ array items are disabled.

Input/output argument.

pvaravarlActivityUserIDs

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

The corresponding item in the array returned by the pvaravarbstrActivityUserNames argument contains the username associated with an activity user ID.

Note:

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

Input/output argument.

pvaravarbstrActivityUserNames

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

Note:

This is a 1-based array.

Note:

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

Input/output argument.