IVSSVersion.LabelComment Property 

Gets a string containing a comment applied to the Label.

Namespace: Microsoft.VisualStudio.SourceSafe.Interop
Assembly: Microsoft.VisualStudio.SourceSafe.Interop (in microsoft.visualstudio.sourcesafe.interop.dll)

Syntax

'Declaration
ReadOnly Property LabelComment As String
'Usage
Dim instance As IVSSVersion
Dim value As String

value = instance.LabelComment

string LabelComment { get; }

property String^ LabelComment {
    String^ get ();
}

/** @property */
String get_LabelComment ()

function get LabelComment () : String

Property Value

A string containing a comment applied to the Label, or an empty string if no comment is provided.

Remarks

[IDL]

HRESULT LabelComment([out, retval] BSTR *pComment);

Example

The following example demonstrates how to iterate through the IVSSVersions collection of a file and display the LabelComment property for each version.

using System;
using Microsoft.VisualStudio.SourceSafe.Interop;

public class IVSSTest
{
    public static void Main()
    {
        string testFile = "$/A/test.txt";

        // Create a VSSDatabase object.
        IVSSDatabase vssDatabase = new VSSDatabase();

        // Open a VSS database using network name 
        // for automatic user login.
        vssDatabase.Open(@"C:\VSSTestDB\srcsafe.ini", 
                         Environment.UserName, ""); 

        // Test Version:
        Console.WriteLine("\n$/A/test.txt versions: \n");
        IVSSItem vssFile = vssDatabase.get_VSSItem(testFile, false);
        Console.WriteLine("-------------------------------------------------");
        Console.WriteLine("{0,-5}{1,-9}{2,-15}{3,-7}{4}", "Ver", 
                          "Label", "Label Comment", "User", "Checked Out");
        Console.WriteLine("-------------------------------------------------");
        foreach(IVSSVersion vssVersion in vssFile.get_Versions(0))
        {
            string status;
            if((VSSFileStatus)vssVersion.VSSItem.IsCheckedOut == 
               VSSFileStatus.VSSFILE_NOTCHECKEDOUT)
                status = "NO";
            else    
                status = "YES";
            Console.WriteLine("{0,-5}{1,-9}{2,-15}{3,-7}{4}", 
                              vssVersion.VersionNumber, vssVersion.Label, 
                              vssVersion.LabelComment, vssVersion.Username, status);
        }    
        Console.WriteLine("-------------------------------------------------");
    }
}

Output:

$/A/test.txt versions:

-------------------------------------------------
Ver  Label    Label Comment   User     Checked Out
-------------------------------------------------
3    Lbl2     Attaching Lbl2  Guest1   NO
2                             Guest1   NO
1    Lbl1     Attaching Lbl1  Guest1   NO

See Also

Reference

IVSSVersion Interface
IVSSVersion Members
Microsoft.VisualStudio.SourceSafe.Interop Namespace