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


pbsProjectName
Project name (see Remarks)
bIsTopParent
True if this is the topmost node in the reference tree, false if not
bPermitReadLocal
True to allow SOLIDWORKS PDM Professional to read reference information if it is not already present in the database, false to disallow SOLIDWORKS PDM Professional to read reference information if it is not already present in the database
bGetSuppressedComponent
True to get a suppressed reference, false to not
lEdmRefFlags
Types of references that you want enumerated as defined in EdmRefFlags
bsConfiguration
Configuration name for which to get child references (see Remarks)
lVersion
Version for which to get references; use 0 for latest version
Starts an enumeration of child references for the specified configuration.

Syntax

Visual Basic 
Function GetFirstChildPosition4( _
   ByRef pbsProjectName As System.String, _
   ByVal bIsTopParent As System.Boolean, _
   ByVal bPermitReadLocal As System.Boolean, _
   ByVal bGetSuppressedComponent As System.Boolean, _
   ByVal lEdmRefFlags As System.Integer, _
   ByVal bsConfiguration As System.String, _
   Optional ByVal lVersion As System.Integer _
) As IEdmPos5
C# 
IEdmPos5 GetFirstChildPosition4( 
   out System.string pbsProjectName,
   System.bool bIsTopParent,
   System.bool bPermitReadLocal,
   System.bool bGetSuppressedComponent,
   System.int lEdmRefFlags,
   System.string bsConfiguration,
   System.int lVersion
)
C++/CLI 
IEdmPos5^ GetFirstChildPosition4( 
&   [Out] System.String^ pbsProjectName,
&   System.bool bIsTopParent,
&   System.bool bPermitReadLocal,
&   System.bool bGetSuppressedComponent,
&   System.int lEdmRefFlags,
&   System.String^ bsConfiguration,
&   System.int lVersion
) 

Parameters

pbsProjectName
Project name (see Remarks)
bIsTopParent
True if this is the topmost node in the reference tree, false if not
bPermitReadLocal
True to allow SOLIDWORKS PDM Professional to read reference information if it is not already present in the database, false to disallow SOLIDWORKS PDM Professional to read reference information if it is not already present in the database
bGetSuppressedComponent
True to get a suppressed reference, false to not
lEdmRefFlags
Types of references that you want enumerated as defined in EdmRefFlags
bsConfiguration
Configuration name for which to get child references (see Remarks)
lVersion
Version for which to get references; use 0 for latest version

Return Value

Position of the first file referenced by this file (see Remarks)

Example

Remarks

You should maintain and pass in a string, by reference, in this argument for all calls to this method in a reference tree. The project name can be allocated and returned by the topmost node in the tree and is used by its children.

IEdmReference6::RefCount and IEdmReference8::RefCountEdited for child references return values for corresponding referenced configurations. If an empty string is passed to bsConfiguration, then the file's common configuration is used.

Pass the position returned by this method to IEdmReference5::GetNextChild to continue to enumerate the referenced files.

C++ programmers not using smart-pointer wrapper functions must release the position.

Return code S_OK indicates that the method successfully executed.

 

See Also

Availability

SOLIDWORKS PDM Professional 2015