API Tasks › Accessing a Model › Using the API as an Add-in Tool › ISCPropertyBag Interface

ISCPropertyBag Interface

The following table contains information on the ISCPropertyBag interface:

Example 3

The following example illustrates how to use the API as an add-in tool to iterate through the open models using C++. The example uses the Application object created in Example 1:

void IteratePersistenceUnits(ISCApplicationPtr & scAppPtr)
{   
    ISCPersistenceUnitCollectionPtr scPUnitColPtr;
    scPUnitColPtr = scAppPtr->GetPersistenceUnits();
    
    ISCPersistenceUnitPtr scPUnit = 0;
    long lCnt = scPUnitColPtr->GetCount();
    
    for(long i = 0; i < lCnt; i++)
    {   
        scPUnit = scPUnitColPtr->GetItem(i);
        CString csName = scPUnit->GetName();   // name of model
        ISCPropertyBagPtr scPropBag = scPUnit->GetPropertyBag("Locator;Active  Model");
        long index = 0;
        CComVariant vPathName = scPropBag->GetValue(ColeVariant(index));  // full
        //path of model       
        index = 1;
        CComVariant cActiveModel = scPropBag->GetValue(COleVariant(index)); // true if active model
        // …
    }
}

The following example illustrates how to use the API as an add-in tool to iterate through the open models using Visual Basic .NET. The example uses the Application object created in Example 1:

Public Sub IteratePersistenceUnits(ByRef scApp As SCAPI.Application)

      Dim scPersistenceUnitCol as SCAPI.PersistenceUnits    
      
      Dim numUnits As Integer
      Dim scPUnit As SCAPI.PersistenceUnit
      
      scPersistenceUnitCol = scApp.PersistenceUnits
      
      ' Count open units
      numUnits = scPersistenceUnitCol.Count
      If (numUnits > 0) Then
	For Each scPUnit In scPersistenceUnitCol
	      Dim propBag As SCAPI.PropertyBag
                  
	      propBag = scPUnit.PropertyBag("Locator")
	      Console.WriteLine( persUnit.Name )   ' name of model
	      Console.WriteLine( propBag.Value(0)) ' full path of model
	       ' …
	 Next
      End If
End Sub