Label.extractComment(String) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Caution
The extractComment method should not be used anymore. Comments about labels were intended for use only during design time and are not available at runtime.
Returns a comment that is associated with a specified label ID.
public:
System::String ^ extractComment(System::String ^ label);
[System.Obsolete("The extractComment method should not be used anymore. Comments about labels were intended for use only during design time and are not available at runtime.")]
public string extractComment (string label);
[<System.Obsolete("The extractComment method should not be used anymore. Comments about labels were intended for use only during design time and are not available at runtime.")>]
member this.extractComment : string -> string
Public Function extractComment (label As String) As String
Parameters
- label
- String
A string that specifies the label ID. The string must include the at sign (@) followed by a label file ID and a number.
Returns
A string value that indicates the comment that is associated with the specified label ID.
- Attributes
Remarks
If you specify a label ID that does not exist, this method returns the specified ID as a string. If you do not include the @ in the label parameter value, the method returns the label ID.