SolidWorksMakroprogrammierung

Methode · SldWorks

GetUserPreferenceIntegerValue-Methode (SldWorks)

Liest eine Zahlen-Systemoption von SOLIDWORKS, zum Beispiel die STEP-Version oder den DXF-Maßstab beim Export.

Syntax

Function GetUserPreferenceIntegerValue( _
   ByVal UserPreferenceValue As Long _
) As Long
nWert = swApp.GetUserPreferenceIntegerValue(UserPreferenceValue)

Parameter

UserPreferenceValueLongByVal

Welche Option, ein Wert aus swUserPreferenceIntegerValue_e, zum Beispiel:

  • swStepAP: STEP-Version beim Speichern als STEP, 203 oder 214
  • swDxfOutputNoScale: DXF/DWG-Export im Maßstab 1:1, 0 aus, 1 ein
  • swDxfMultiSheetOption: welche Blätter einer Zeichnung als DXF exportiert werden, ein Wert aus swDxfMultisheet_e

Rückgabewert

Der Wert der Option. Was die Zahl bedeutet, hängt von der Option ab.

Beispiel

' Zeigt die eingestellte STEP-Version und ob DXF im Maßstab 1:1 exportiert wird.
' Vorbedingung: SOLIDWORKS läuft.
' Ergebnis:     Meldung mit beiden Einstellungen.
Option Explicit

Sub main()
    Dim swApp As SldWorks.SldWorks

    Set swApp = Application.SldWorks

    swApp.SendMsgToUser2 "STEP-Version: AP" & swApp.GetUserPreferenceIntegerValue(swStepAP) & vbCrLf & _
                         "DXF 1:1: " & IIf(swApp.GetUserPreferenceIntegerValue(swDxfOutputNoScale) = 1, "ein", "aus"), _
                         swMbInformation, swMbOk
End Sub

Bemerkungen

GetUserPreferenceIntegerValue liest Systemoptionen, die für alle Dokumente gelten, etwa die Export-Einstellungen unter Extras › Optionen › Systemoptionen › Exportieren. Zahlen-Einstellungen eines einzelnen Dokuments, etwa sein Einheitensystem, liest ModelDocExtension.GetUserPreferenceInteger.

Welcher Wert zu welcher Option im Dialog gehört und welche Zahlen erlaubt sind, steht in der englischen Hilfe auf den Seiten „System Options and Document Properties“.

Der übliche Einsatz: Vor einem Export liest das Makro die Option, stellt sie mit SldWorks.SetUserPreferenceIntegerValue passend ein und schreibt danach den alten Wert zurück. Ein Beispiel dafür steht dort.

Siehe auch

In den Videos

Verfügbarkeit

In allen aktuellen Versionen vorhanden. Seit wann es den Befehl gibt, nennt die Hilfe nicht.

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

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