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

API: Presentation.GetPropertiesForPresentation

Scoped Name

APIServer.Presentation.GetPropertiesForPresentation

Interface

Field Variable ...as Description
PresentationSurrogate Position Input The unique identification of the presentation. This is used to restrict the retrieved data.
PropertyName Position Input The name of the property. This is used to position the retrieved data.
Position Control Input Specify whether the API should position based on the Position variable
RowsFetched Control Dual Returns the number of rows returned for the Presentation
PresentationSurrogate FetchedData (64) Output The unique identification of the presentation.
PropertyName FetchedData (64) Output The name of the property
Value FetchedData (64) Output The value specified for the property

Description

This API is a blockfetch function that retrieves all the properties specified for a presentation (the presentation surrogate is used to restrict the data).

The most common case is that the properties should be retrieved for the current presentation for the session. In this case use the webserver API GetCurrentPresentation to retrieve this surrogate.

Events

WSE0021 - Presentation not found

Universal events