Méthode IRegistrationInfo ::p ut_Documentation (taskschd.h)

  • Article

Obtient ou définit toute documentation supplémentaire pour la tâche.

Cette propriété est en lecture/écriture.

Syntaxe

HRESULT put_Documentation(
  BSTR documentation
);

Paramètres

documentation

Valeur de retour

None

Remarques

Lors de la lecture ou de l’écriture de code XML pour une tâche, la documentation supplémentaire de la tâche est spécifiée à l’aide de l’élément Documentation du schéma task Scheduler.

Lorsque vous définissez cette valeur de propriété, la valeur peut être du texte récupéré à partir d’un fichier de .dll de ressource. Une chaîne spécialisée est utilisée pour référencer le texte du fichier de ressources. Le format de la chaîne est $(@ [Dll], [ResourceID]) où [Dll] est le chemin d’accès au fichier .dll qui contient la ressource et [ResourceID] est l’identificateur du texte de la ressource. Par exemple, la définition de la valeur de cette propriété sur $(@ %SystemRoot%\System32\ResourceName.dll, -101) définit la propriété sur la valeur du texte de ressource avec un identificateur égal à -101 dans le fichier %SystemRoot%\System32\ResourceName.dll.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2008 [applications de bureau uniquement]
Plateforme cible Windows
En-tête taskschd.h
Bibliothèque Taskschd.lib
DLL Taskschd.dll

Voir aussi

IRegistrationInfo

Planificateur de tâches