WorkSession.GetCurrentInterview Method (InterviewSettings, IEnumerable(String), String)

WorkSession GetCurrentInterview Method (InterviewSettings, IEnumerable String , String)

Returns the current interview with the given settings

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

Syntax

public InterviewResult GetCurrentInterview(
	InterviewSettings settings,
	IEnumerable<string> markedVariables,
	string logRef = ""
)

public InterviewResult GetCurrentInterview(
	InterviewSettings settings,
	IEnumerable<string> markedVariables,
	string logRef = ""
)

settings: Type: HotDocs.Sdk InterviewSettings
Settings to use with the interview.

markedVariables: Type: System.Collections.Generic IEnumerable String
A list of variable names whose prompts should be "marked" in the interview.

logRef (Optional): Type: System String
A string identifying the current user or transcation, to be included in HotDocs log entries. This is necessary if you wish to track log entries back to specific users during analysis or troubleshooting.

Type: InterviewResult
An InterviewResult containing the HTML fragment and other supporting files for the interview.