Websydian v6.1 online documentationOnline documentation - WebsydianExpress v3.0

API - GetCurrentPresentation

Scoped Name

APIWebServer.GetCurrentPresentation

Interface

Field Variable ...as Description
PresentationSurrogate FetchedData Output The unique identification of the current presentation.
TemplateSuffix FetchedData Output The suffix used to specify that the HTML templates are belonging to the current presentation.
TemplateOverrideName FetchedData Output The override name specified for the current presentation.
PresentationName FetchedData Output The name of the current presentation.
PresentationComment FetchedData Output Any comments specified for the current presentation
ProcessSurrogate FetchedData Output The unique identification of the process that the presentation belongs to.
ProcessID FetchedData Output The program name of the ProcessEntryPoint used by the process that the presentation belongs to.
ProcessType FetchedData Output The type of the process that the presentation belongs to. The type can be either Business Process (literal value 4), Menu Loader (literal value 5), or Frameset Loader (literal value 6).
ProcessDescription FetchedData Output The description specified for the process that the presentation belongs to
ProcessComment FetchedData Output Any comments specified for the process that the presentation belongs to.
ProcessText FetchedData Output The name of the process that the presentation belongs to.

Description

This API can be used to retrieve information about the current presentation used by the process. The retrieved presentation surrogate can be used to fetch any property values specified for the presentation (using the server API's GetPresentationProperty and GetPropertiesForPresentation).

Events

Universal events