Activates a Category that has been paused with the PauseCategory(UserCredential, String) method. A Category that has been paused is not available until it has been activated.

Namespace: Microsoft.Tag.CampaignManagement
Assembly: Microsoft.Tag.CampaignManagement (in Microsoft.Tag.CampaignManagement.dll) Version: 1.0.7785.0 (1.0.7785.0)

Syntax

C#
bool ActivateCategory(
	UserCredential userCredential,
	string categoryName
)
Visual Basic
Function ActivateCategory ( _
	userCredential As UserCredential, _
	categoryName As String _
) As Boolean
Visual C++
bool ActivateCategory(
	UserCredential^ userCredential, 
	String^ categoryName
)

Parameters

userCredential
Type: Microsoft.Tag.CampaignManagement..::..UserCredential
A 64-bit encrypted GUID specifying the user credential.
categoryName
Type: System..::..String
The name of the category to be activated.

Return Value

true if the method succeeds

false if the method fails

Remarks

A Category that has been paused with the PauseCategory(UserCredential, String) method must be activated with this method before it and the Tags it contains are available.

ActivateCategory fails when passed a Category with an invalid status.

Examples

This code sample demonstrates how to call ActivateCategory(UserCredential, String).
CopyC#
private void LocalActivateCategory()
{
    try
    {
        MIBPContractClient OMIBPClient = new MIBPContractClient();
        UserCredential oCredential = new UserCredential();

        oCredential.AccessToken = "Enter your access token";
        OMIBPClient.ActivateCategory(oCredential, "Category Name");
    }
    catch
    {
        throw;
    }
}

See Also