SolidWorksMakroprogrammierung

Methode · CustomPropertyManager

Set2-Methode (CustomPropertyManager)

Ändert den Wert einer vorhandenen Dateieigenschaft.

Syntax

Function Set2( _
   ByVal FieldName As String, _
   ByVal FieldValue As String _
) As Long
nErgebnis = swProps.Set2(FieldName, FieldValue)

Parameter

FieldNameStringByVal
Der Name der vorhandenen Eigenschaft.
FieldValueStringByVal
Der neue Wert als Text.

Rückgabewert

Ein Ergebniscode aus swCustomInfoSetResult_e:

  • swCustomInfoSetResult_OK (0): geändert
  • swCustomInfoSetResult_NotPresent (1): die Eigenschaft gibt es nicht
  • swCustomInfoSetResult_TypeMismatch (2): der Wert passt nicht zum Typ der Eigenschaft
  • swCustomInfoSetResult_LinkedProp (3): die Eigenschaft ist verknüpft und lässt sich hier nicht ändern

Beispiel

' Erhöht die Dateieigenschaft "Index" um 1. Gibt es sie noch nicht, wird sie mit 1 angelegt.
' Vorbedingung: Ein Dokument ist geöffnet.
' Ergebnis:     "Index" ist um 1 höher, die Meldung zeigt den neuen Wert.
Option Explicit

Sub main()
    Dim swApp As SldWorks.SldWorks
    Dim swModel As SldWorks.ModelDoc2
    Dim swProps As SldWorks.CustomPropertyManager
    Dim sWert As String
    Dim sErgebnis As String
    Dim nIndex As Long

    Set swApp = Application.SldWorks
    Set swModel = swApp.ActiveDoc
    If swModel Is Nothing Then Exit Sub
    Set swProps = swModel.Extension.CustomPropertyManager("")

    swProps.Get6 "Index", False, sWert, sErgebnis, False, False
    nIndex = Val(sErgebnis) + 1

    If swProps.Set2("Index", CStr(nIndex)) = swCustomInfoSetResult_NotPresent Then
        swProps.Add3 "Index", swCustomInfoText, CStr(nIndex), swCustomPropertyOnlyIfNew
    End If

    swModel.SetSaveFlag
    swApp.SendMsgToUser2 "Neuer Index: " & nIndex, swMbInformation, swMbOk
End Sub

Bemerkungen

Set2 ändert nur Eigenschaften, die es schon gibt. Eine neue legt es nicht an, sondern meldet swCustomInfoSetResult_NotPresent. Das Beispiel nutzt genau das: erst Set2 versuchen, bei Bedarf mit CustomPropertyManager.Add3 anlegen. Wer nicht unterscheiden muss, nimmt gleich Add3 mit swCustomPropertyReplaceValue.

Den Typ der Eigenschaft ändert Set2 nicht. Passt der neue Wert nicht dazu, etwa ein Text in einer Zahlen-Eigenschaft, kommt swCustomInfoSetResult_TypeMismatch zurück.

Der Vorgänger Set ist veraltet.

Siehe auch

Verfügbarkeit

SOLIDWORKS 2014

Englisches Original: ICustomPropertyManager::Set2 in der SOLIDWORKS API-Hilfe ↗ (dort mit dem .NET-Namen)

Fragen zu diesem Befehl oder ein Befehl fehlt? Frag im Discord.