Método IScheduledWorkItem::GetTriggerString (mstask.h)

  • Artículo

[[Esta API puede modificarse o no estar disponible en versiones posteriores del sistema operativo o del producto. Use las interfaces del Programador de tareas 2.0 en su lugar. ]

Recupera una cadena que describe el desencadenador del elemento de trabajo .

Sintaxis

HRESULT GetTriggerString(
  [in]  WORD   iTrigger,
  [out] LPWSTR *ppwszTrigger
);

Parámetros

[in] iTrigger

Índice del desencadenador que se va a recuperar. El primer desencadenador siempre se hace referencia a 0. Para obtener más información, vea la sección Comentarios.

[out] ppwszTrigger

Puntero a una cadena terminada en null que contiene la descripción del desencadenador recuperado. Tenga en cuenta que esta cadena debe liberarse mediante una llamada a CoTaskMemFree después de que la cadena ya no sea necesaria.

Valor devuelto

El método GetTriggerString devuelve uno de los valores siguientes.

Código devuelto Descripción
S_OK
 La operación se realizó correctamente.
E_INVALIDARG
 Los argumentos no son válidos.
E_OUTOFMEMORY
 No hay suficiente memoria disponible.

Comentarios

Un índice de desencadenador no es un identificador. Solo indica la posición del desencadenador en relación con los desencadenadores actuales asociados al elemento de trabajo. Por ejemplo, si crea cuatro desencadenadores, se numerarán de 0 a 3. Pero si se elimina el segundo desencadenador, los desencadenadores restantes se numerarán de 0 a 2. Tenga en cuenta que el índice del primer desencadenador siempre es 0 y el índice del último desencadenador es uno menor que el número total de desencadenadores para el elemento de trabajo (TriggerCount -1).

Puede recuperar el recuento de desencadenadores mediante IScheduledWorkItem::GetTriggerCount.

Ejemplos

Para obtener un ejemplo de cómo recuperar la cadena de desencadenador de todos los desencadenadores asociados a una tarea, consulte Ejemplo de recuperación de cadenas de desencadenador.

Requisitos

Requisito Value
Cliente mínimo compatible Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado mstask.h
Library Mstask.lib
Archivo DLL Mstask.dll
Redistribuible Internet Explorer 4.0 o posterior en Windows NT 4.0 y Windows 95

Consulte también

IScheduledWorkItem

ITask