SOLIDWORKS PDM Professional API Help Send Feedback
GetNextFolderID Method (IEdmLabel5)
See Also 
EPDM.Interop.epdm Namespace > IEdmLabel5 Interface : GetNextFolderID Method (IEdmLabel5)


poPos
IEdmPos5; position of the next folder (see Remarks)
Gets the next ID of a folder with this label in the enumeration.

Syntax

Visual Basic 
Function GetNextFolderID( _
   ByVal poPos As IEdmPos5 _
) As System.Integer
C# 
System.int GetNextFolderID( 
   IEdmPos5 poPos
)
C++/CLI 
System.int GetNextFolderID( 
&   IEdmPos5^ poPos
) 

Parameters

poPos
IEdmPos5; position of the next folder (see Remarks)

Return Value

ID of folder on which this label is set

Remarks

Before calling this method the first time, you must populate poPos with the interface to the position of the first folder with this label, IEdmPos5. Call IEdmLabel5::GetFirstFolderPosition to obtain IEdmPos5.

After calling this method the first time, poPos is automatically incremented every time it is called. Call this method repeatedly to obtain the rest of the folder IDs.

Be sure to call IEdmPos5::IsNull before you call this method to ensure you have not reached the end of the enumeration.

Return codes:

  • S_OK: The method successfully executed.
  • E_EDM_END_OF_LIST: You have gone past the end of the list.
 

See Also

Availability

SOLIDWORKS PDM Professional Version 5.2