IHDSvc.BuildSupportFiles Method

IHDSvc BuildSupportFiles Method

This web service builds the manifest and other server files for a template.

Namespace: HotDocs.Sdk.Server.Contracts
Assembly: HotDocs.Sdk.Server.Contracts (in HotDocs.Sdk.Server.Contracts.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C++

Copy to Clipboard Print

void BuildSupportFiles(
	string templateID,
	string templateKey,
	HDSupportFilesBuildFlags buildFlags,
	string templateState
)

void BuildSupportFiles(
	string templateID,
	string templateKey,
	HDSupportFilesBuildFlags buildFlags,
	string templateState
)

Parameters

templateID: Type: System String
The file name (not including the path) of the template to assemble.

templateKey: Type: System String
Version-specific identifier for the parent template, for templates not at a fixed location.

buildFlags: Type: HotDocs.Sdk.Server.Contracts HDSupportFilesBuildFlags
Specifies which files (besides the manifest) to build. See HDSupportFilesBuildFlags for details.

templateState: Type: System String
This parameter is either null if the template is located in the web service's default template directory (as specified in web.config), or it is an encrypted value encapsulating the location of the template.

Remarks

Usually, a manifest is built on the desktop with HotDocs Developer when publishing a template. When a template is installed on a server without a manifest, this function may be called to build the manifest. HotDocsServer will build and cache the JavaScript or Silverlight interview files upon first use. BuildSupportFiles may be used to prebuild the interview files so that they are already in the cache the first time they are requested.