Hide Table of Contents
CreateLabel Method (IEdmFolder5)

Creates a label on this folder and its files.

Syntax

Visual Basic (Declaration) 
Function CreateLabel( _
   ByVal bsName As System.String, _
   ByVal bsDescription As System.String, _
   Optional ByVal bRecursively As System.Boolean _
) As System.Integer
C# 
System.int CreateLabel( 
   System.string bsName,
   System.string bsDescription,
   System.bool bRecursively
)
C++/CLI 
System.int CreateLabel( 
&   System.String^ bsName,
&   System.String^ bsDescription,
&   System.bool bRecursively
)

Parameters

bsName
Name of the label; maximum of 255 characters
bsDescription
Label description to show in the history dialog box; maximum of 2000 characters
bRecursively
Optionally, true to set the label recursively on subfolders, false to not; default is true

Return Value

ID of the new label

Example

Remarks

Return codes:

  • S_OK: The method successfully executed.
  • S_FALSE: One of the arguments in invalid.
 

See Also

Availability

SOLIDWORKS Enterprise PDM Version 5.2


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   CreateLabel Method (IEdmFolder5)
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:

x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2015 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.

0.20.26