GetCampaign Method

Article
11/12/2009

Retrieves an existing Campaign, as identified by the Campaign's unique identifier.

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

Syntax

'Declaration
<WebMethodAttribute> _
Public Overridable Function GetCampaign ( _
    campaignId As Integer _
) As CampaignData

'Usage
Dim instance As MarketingWebService
Dim campaignId As Integer
Dim returnValue As CampaignData

returnValue = instance.GetCampaign(campaignId)

[WebMethodAttribute]
public virtual CampaignData GetCampaign(
    int campaignId
)

[WebMethodAttribute]
public:
virtual CampaignData^ GetCampaign(
    int campaignId
)

public function GetCampaign(
    campaignId : int
) : CampaignData

Parameters

campaignId
Type: System..::.Int32
The identifier of the campaign to retrieve. May not be zero or less.

Return Value

Type: CampaignData
A CampaignData instance containing the campaign specified by campaignId, retrieved from the database.

Exceptions

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

Remarks

Retrieves an existing Campaign, as identified by the Campaign's unique identifier.

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