GetDisplayName

Description

Returns the display name (a unique key) associated with the Entity.

Pour les types d'enregistrement basé sur l'état, la clé unique est l'ID visible de l'enregistrement, au format BDnnnnnn (par exemple, PASNY00012332), où BD est le nom de la base de données et nnnnnn est le numéro d'enregistrement.

Pour les types d'enregistrement sans état, la clé unique est constituée des valeurs des zones de la clé unique définies par l'administrateur. S'il n'existe qu'une seule zone de clé unique, sa valeur sera la clé unique. S'il existe plusieurs zones composant la clé unique, leurs valeurs seront concaténées dans l'ordre spécifié par l'administrateur. Pour les types d'enregistrement basés sur l'état, l'appel de cette méthode équivaut à obtenir la valeur de la zone système "id" à l'aide d'un Objet FieldInfo.

La clé unique ne doit pas être confondue avec l'ID base de données, que l'utilisateur ne peut pas voir. L'ID base de données est extrait par la méthode GetDbId.

Syntaxe

VBScript

entity.GetDisplayName 

Perl

$entity->GetDisplayName(); 
Identificateur
Description
entity
Objet Entity représentant un enregistrement de données utilisateur. Si vous omettez cette partie de la syntaxe au sein d'un point d'ancrage, l'objet Entity correspondant à l'enregistrement de données en cours est faux (VBScript uniquement).
Return value
A String containing the record type's unique key.

Exemples

VBScript

' Get the record ID using 2 different techniques and compare the
' results
displayName = GetDisplayName 
idName = GetFieldValue("id").GetValue 
If idName <> displayName Then 
  ' Error, these id numbers should match 
End If 

Perl

# Get the record ID using 2 different techniques and compare the 
# results
$displayname = $entity->GetDisplayName();
$idname = $entity->GetFieldValue("id")->GetValue();
if ($idname ne $displayname)
 {
 # error, these id numbers should match
 } 

Commentaires