EnumUsersRolesForBiPub

Generates report in specified format (PDF, RTF, HTML or XLS) and returns a localized XML string that lists the roles to which the specified users are assigned.

Syntax

<HFMwSecurity>.EnumUsersRolesForBiPub(bstrLanguage, bstrUsersXml, 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.

bstrUsersXml

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

<Users><User><Name>username</Name><Id>security identifier</Id></User></Users>

Input argument. String 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 list the users’ assigned roles. Following is the structure of the string. There is one <User> element per user; each <User> element contains one <Role> element per assigned role. 

<UserRights><User name="username" id="security identifier" ><Roles NODISPLAY='Yes/No'><Role> role label</Role></Roles><Classes NODISPLAY='Yes/No'><Classes></User></UserRights>

String subtype.