FireNamedHook

Description

Ejecuta un enganche denominado (script de registro) del objeto EntityDef de este registro.

Puede utilizar este método para ejecutar un script de registro en tiempo de ejecución. Los scripts de registro son rutinas que define el usuario y que son específicas para un tipo de registro concreto. Puede utilizar scripts de registro junto con controles de formulario, o bien, se pueden llamar desde otros enganches. Los enganches de registro se definen utilizando Rational ClearQuest Designer. La sintaxis de los scripts de registro es la siguiente:

Function EntityDefName_RecordScriptName(param)
   ' param as Variant 
   ' EntityDefName_RecordScriptName como Variant 

   ' Hook program body 
End Function 

Este método no se puede utilizar para ejecutar un enganche de acción o campo de un registro. Tampoco se puede ejecutar un enganche global, excepto indirectamente desde el script de registro.

Puede llamar a este método en un objeto Entity, sin tener en cuenta si puede editar. Sin embargo, si el script intenta modificar el objeto Entity, el código o el enganche de código deben llamar antes al método EditEntity para que el objeto Entity se pueda editar.

Si el script acepta cualquier parámetro, ponga todos los parámetros en un solo valor Variant (para Visual Basic) y especifique dicho valor Variant en param. El script debe poder interpretar los parámetros que se le pasan. En el retorno, el script puede devolver de modo similar un valor Variant con cualquier valor de retorno adecuado.

Para Perl, puede incluir varios parámetros concatenando valores de serie simples con un carácter no imprimible como separador (por ejemplo, una nueva línea). A continuación, el valor String se puede descodificar con el operador split incorporado.

Sintaxis

VBScript

entity.FireNamedHook scriptName, param 

Perl

$entity->FireNamedHook(scriptName, param); 
Identificador
Description
entity
Un objeto Entity que representa un registro de datos de usuario. En un enganche, si se omite esta parte de la sintaxis, se presupone el objeto Entity correspondiente al registro de datos actual (sólo VBScript).
scriptName
Un valor String que contiene el nombre del enganche a ejecutar.
param
Para Visual Basic, un valor Variant que contiene los parámetros que se desea pasar al enganche. Para Perl, un valor String que contiene los parámetros que se desea pasar al enganche.
Valor de retorno
Un valor String que indica el estado de llamada al enganche. Si el enganche se ejecuta satisfactoriamente, este método devuelve una serie vacía ("") y, de lo contrario, la serie devuelta contiene una descripción del error.

Ejemplos

VBScript

' Execute the hook "MyHook" with the specified parameters

Dim params(1) 

params(0) = "option 1" 

params(1) = "option 2" 

returnValue = entity.FireNamedHook("MyHook", params) 

Perl

# Execute the hook "MyHook" with the specified parameters

$params = "option 1\noption 2";

$returnValue = $entity->FireNamedHook("MyHook",$params);



# In the hook, split them like this:

my $param = shift;

my @params = split '\n', $param; 

Comentarios