EnumUsersInGroupForBiPub

Generates report in specified format (PDF, RTF, HTML or XLS) and returns the security identifiers, usernames, and identity types of the users in a user group.

Syntax

<HFMwSecurity>.EnumUsersInGroupForBiPub(bstrLanguage, bstrGroupsXml, lBitmaskFlags, lReportFormat, bstrReportTemplateFileName, ReportFileOut)
ArgumentDescription
bstrLanguage

String (ByVal). The two-letter language code representing the language in which to return the string. To obtain language codes, use GetLanguageCountryCodeFromLanguageId.

Input argument. String subtype.

bstrGroupsXml

An XML string that specifies the user groups’ names and security identifiers. Following is the structure of the string, which must contain one <User> element per group:

<Users><User><Name>group name</Name><Id>security identifier</Id></User></Users>

Input argument. String subtype.

lBitmaskFlags

A bitmask that specifies the identity types of the users to return. Valid values for the bits are represented by the HFMConstants enumeration described in User Groups - User Type Flag Constants.

For example, to exclude bits for application administrators from the array, pass HFM_USER_GROUP_ENUM_EXCLUDEADMINS.

Input argument. Long subtype.

lReportFormat

Value that specifies the report output format:

  • 1 = PDF format

  • 2 = RTF format

  • 3 = HTML format

  • 4 = XLS format

  • -1 = Financial Management format

Input argument. Long subtype.

bstrReportTemplateFileName

The BI Publisher report template name that is used to generate the report.

Input argument. String subtype.

ReportFileOut

Specifies the file name of the report generated.

Input argument. String subtype.

Return Value

Returns an XML string that specifies the users’ usernames, security identifiers, and identity type bitmasks. Following is the structure of the string. There is one <Group> element per user group; each <Group> element contains one <User> element per user. Valid values for the bits in the identity type bitmasks are represented by the HFMConstants enumeration described in Identity Type Constants.

<Groups NODISPLAY='Yes/No'><Group name="group name" id="security identifier" ><GUser name” username" id="security identifier" type="identity type bitmask" /></Group></Groups>

String subtype.