GetDisplayNamesNeedingSiteExtension

Description

Gets the site-extended names of all stateless entities of the specified record type that need site extension.

This method supports MultiSite operations. Its purpose is to avoid name collisions.

For example, at different sites, there may be two users named "Tom", which could cause a name collision in a MultiSite environment. Each user "Tom" can login with their local name, but to be unique in a MultiSite environment, the name of each "Tom" needs to be "site-extended", meaning a site-specific suffix needs to be added. This method returns stateless names that are site-extended.

This method applies only to "stateless" record types, such as the names of users, groups, choice lists, workspaces, queries, reports, charts, and folders.

You can use site-extended names wherever unextended names are used.

Syntax

VBScript

session.GetDisplayNamesNeedingSiteExtension entity_def_name

Perl

$session->GetDisplayNamesNeedingSiteExtension($entity_def_name);

Identifier

Description

session

The Session object for the current database session.

entity_def_name

A String containing an EntityDef name (the name of the record type). This is the name returned by the GetName in EntityDef.

Return value

In Visual Basic, the return value is a Variant consisting of an array of strings.

In Perl, the return value is a reference to an array of strings.