DisplayNameHeader

Descripción

Devuelve las claves exclusivas de los elementos de historial de este campo.

Es una propiedad de sólo lectura; se puede visualizar, pero no se puede establecer. Las claves exclusivas se establecen utilizando Rational ClearQuest Designer, no la API de Rational ClearQuest.

Sintaxis

VBScript

historyField.DisplayNameHeader 

Perl

$historyField->GetDisplayNameHeader(); 
Identificador
Descripción
historyField
Un objeto HistoryField que representa un campo de un registro.
Valor de retorno
Para Visual Basic, un valor Variant que contiene una matriz cuyos elementos son series. Cada serie contiene la clave exclusiva del elemento correspondiente en la recopilación de objetos Histories del campo. Para Perl, una referencia a una matriz de series.

Ejemplos

VBScript

' This example assumes there is at least 1 history field 

' associated with the record. 

set sessionObj = GetSession

set historyFields = entity.HistoryFields 

set historyField1 = historyFields.Item(0) 

keys = historyField1.DisplayNameHeader 

x = 0 

For Each key in keys 

     sessionObj.OutputDebugString "Displaying key number " & x & " - " & key 
& vbcrlf

     x = x + 1 

Next 

Perl

# This example assumes that there is at least 1 history 

# field associated with the record. Otherwise, GetHistoryFields

# won't return anything interesting and an error would be generated

$session = $entity->GetSession();

# Get the collection of history fields

$historyfields = $entity->GetHistoryFields();



# Get the first history field

$historyfield1 = $historyfields->Item(0)



# Get the list of unique keys for identifying each history.

$keys = $historyfield1->GetDisplayNameHeader();



# Iterate through the list of keys and print the key value

$x = 0;

foreach $key (@$keys)

 {

 $session->OutputDebugString("Displaying key number".$x." - 

      ".$key);

 $x++;

 } 

Feedback