GetDisplayTemplate Method

Article
11/12/2009

Retrieves an existing DisplayTemplate from the system as identified by the specified identifier.

Namespace: Microsoft.CommerceServer.Marketing.WebService
Assembly: Microsoft.CommerceServer.Marketing.DataManagement (in Microsoft.CommerceServer.Marketing.DataManagement.dll)

Syntax

'Declaration
<WebMethodAttribute> _
Public Overridable Function GetDisplayTemplate ( _
    displayTemplateId As Integer _
) As DisplayTemplateData

'Usage
Dim instance As MarketingWebService
Dim displayTemplateId As Integer
Dim returnValue As DisplayTemplateData

returnValue = instance.GetDisplayTemplate(displayTemplateId)

[WebMethodAttribute]
public virtual DisplayTemplateData GetDisplayTemplate(
    int displayTemplateId
)

[WebMethodAttribute]
public:
virtual DisplayTemplateData^ GetDisplayTemplate(
    int displayTemplateId
)

public function GetDisplayTemplate(
    displayTemplateId : int
) : DisplayTemplateData

Parameters

displayTemplateId
Type: System..::.Int32
The identifier of the DisplayTemplate to retrieve.

Return Value

Type: DisplayTemplateData
The DisplayTemplateData instance associated with displayTemplateId.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	displayTemplateId is less than zero.
NotAuthorizedException	The user is not authorized to perform the requested operation.
EntityDoesNotExistException	No item exists with this displayTemplateId.
DatabaseIntegrityException	A serious integrity issue with the database exists.

Remarks

Use this method to retrieve a specific DisplayTemplateData containing the DisplayTemplate object from the database.

Permissions

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via