Método IRegistrationInfo::get_Documentation (taskschd.h)

Obtém ou define qualquer documentação adicional para a tarefa.

Essa propriedade é leitura/gravação.

Sintaxe

HRESULT get_Documentation(
  BSTR *pDocumentation
);

Parâmetros

pDocumentation

Valor retornado

Nenhum

Comentários

Ao ler ou gravar XML para uma tarefa, a documentação adicional da tarefa é especificada usando o elemento Documentation do esquema do Agendador de Tarefas.

Ao definir esse valor de propriedade, o valor pode ser um texto recuperado de um arquivo de .dll de recursos. Uma cadeia de caracteres especializada é usada para fazer referência ao texto do arquivo de recurso. O formato da cadeia de caracteres é $(@ [Dll], [ResourceID]) em que [Dll] é o caminho para o arquivo .dll que contém o recurso e [ResourceID] é o identificador do texto do recurso. Por exemplo, a configuração desse valor de propriedade como $(@ %SystemRoot%\System32\ResourceName.dll, -101) definirá a propriedade como o valor do texto do recurso com um identificador igual a -101 no arquivo %SystemRoot%\System32\ResourceName.dll.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2008 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	taskschd.h
Biblioteca	Taskschd.lib
DLL	Taskschd.dll

Confira também

IRegistrationInfo

Agendador de Tarefas