Share via


IDeliveryExtension.ValidateUserData(Setting[]) Method

Definition

Used to determine whether a given set of delivery extension settings are valid.

public:
 cli::array <Microsoft::ReportingServices::Interfaces::Setting ^> ^ ValidateUserData(cli::array <Microsoft::ReportingServices::Interfaces::Setting ^> ^ settings);
public Microsoft.ReportingServices.Interfaces.Setting[] ValidateUserData (Microsoft.ReportingServices.Interfaces.Setting[] settings);
abstract member ValidateUserData : Microsoft.ReportingServices.Interfaces.Setting[] -> Microsoft.ReportingServices.Interfaces.Setting[]
Public Function ValidateUserData (settings As Setting()) As Setting()

Parameters

settings
Setting[]

An array of Setting objects containing extension settings supplied by a client.

Returns

An array of Setting objects containing extension settings that have been validated by the delivery extension.

Remarks

The ValidateUserData method is called whenever a subscription is created or modified. You should add code to the ValidateUserData method to ensure that the values that a user has chosen for a delivery extension's settings meet the requirements for delivery. For example, in e-mail delivery, you might want to ensure that the e-mail address that is supplied by the user conforms to e-mail formatting standards. In printer delivery, you might want to validate the printer that a user chooses against the known list of installed printers on the server.

If a particular setting that you validate contains an error condition, you should set the Error property of the setting that is not valid. In addition, you can add default values for settings that are missing to prevent the delivery from failing.

Applies to