Welcome
Expand Getting StartedGetting Started
Expand SOLIDWORKS API HelpSOLIDWORKS API Help
Collapse SOLIDWORKS Electrical API HelpSOLIDWORKS Electrical API Help
Expand Getting StartedGetting Started
Expand Release NotesRelease Notes
Collapse ClassesClasses
Expand Class ListClass List
Class Index
Collapse Class HierarchyClass Hierarchy
_DIEwProjectXEvents
Collapse IDispatchIDispatch
IEwAddIn
IEwAPIX
IEwApplicationReactorX
IEwApplicationSettingsX
IEwApplicationX
IEwArchiveEnvironmentX
IEwCableCoreX
IEwCableReferenceManagerX
IEwCableReferenceX
IEwCommandContextX
IEwCommandManagerX
IEwCommandX
IEwDialogAlignPartsParametersSelectorX
IEwDialogLocationSelectorX
IEwDialogMacroSelectorX
IEwDialogManufacturerPartOrderingX
IEwDialogManufacturerPartSelectorX
IEwDialogProgressX
IEwDialogProjectManagerX
IEwDialogResumeX
IEwDialogSummaryX
IEwDialogTaskX
IEwDockingPaneManagerX
IEwDockingPaneX
IEwEnvironmentX
IEwInteropFactoryX
IEwLibraryManagerX
IEwLibraryX
IEwLockStringX
IEwManufacturerPartCircuitX
IEwManufacturerPartManagerX
IEwManufacturerPartTerminalX
IEwManufacturerPartX
Expand IEwObjectBaseXIEwObjectBaseX
IEwPointX
IEwProjectAutomaticArrowsX
IEwProjectBookManagerX
IEwProjectCableManagerX
IEwProjectComponentManagerX
IEwProjectComponentTerminalX
IEwProjectEntity3DManagerX
IEwProjectExcelAutomationX
IEwProjectExportDWGFilesX
IEwProjectExportPDFX
IEwProjectExportPDMX
IEwProjectExportReportX
IEwProjectFileManagerX
IEwProjectFolderManagerX
IEwProjectFunctionManagerX
IEwProjectGenerateTSDrawingX
IEwProjectHarnessManagerX
IEwProjectInputOutputManagerX
IEwProjectLocationManagerX
IEwProjectManagerX
IEwProjectManufacturerPartCircuitX
IEwProjectManufacturerPartManagerX
IEwProjectManufacturerPartTerminalX
IEwProjectManufacturerPartX
IEwProjectNumberDocumentsX
IEwProjectNumberMarksX
IEwProjectNumberWiresX
IEwProjectOptimizeWireOrderX
IEwProjectPrintConfigManagerX
IEwProjectReportManagerX
IEwProjectSnapshotManagerX
IEwProjectSnapshotX
IEwProjectSymbolManagerX
IEwProjectUpdateReplaceDataX
IEwProjectWireManagerX
IEwProjectX
IEwResumeRowX
IEwRibbonControlX
IEwRibbonGroupX
IEwRibbonTabX
IEwRibbonX
IEwRightsManagerX
IEwSymbolCircuitX
IEwSymbolFiltersX
IEwSymbolManagerX
IEwSymbolPointX
IEwSymbolX
IEwTitleBlockManagerX
IEwTitleBlockX
IEwXLSBookX
IEwXLSSheetX
Expand Class MembersClass Members
Expand SOLIDWORKS PDM Professional API HelpSOLIDWORKS PDM Professional API Help
Expand FeatureWorks API HelpFeatureWorks API Help
Expand SOLIDWORKS Costing API HelpSOLIDWORKS Costing API Help
Expand SOLIDWORKS Document Manager API HelpSOLIDWORKS Document Manager API Help
Expand SOLIDWORKS Routing API HelpSOLIDWORKS Routing API Help
Expand SOLIDWORKS Simulation API HelpSOLIDWORKS Simulation API Help
Expand SOLIDWORKS Sustainability API HelpSOLIDWORKS Sustainability API Help
Expand SOLIDWORKS Toolbox API HelpSOLIDWORKS Toolbox API Help
Expand SOLIDWORKS Utilities API HelpSOLIDWORKS Utilities API Help
Expand eDrawings API HelpeDrawings API Help
Expand DraftSight API HelpDraftSight API Help
Expand Lisp Programming BasicsLisp Programming Basics
Expand Lisp Functions OverviewLisp Functions Overview
Expand Lisp Functions ReferenceLisp Functions Reference
Expand Visual Lisp Compatible FunctionsVisual Lisp Compatible Functions
Hide Table of Contents
SOLIDWORKS Electrical API  2021.0.0
Electrical API
Public Member Functions | List of all members
IEwRightsManagerX Interface Reference

Use this interface to manage the application rights. More...

Inheritance diagram for IEwRightsManagerX:
[legend]

Public Member Functions

VARIANT_BOOL canEditFile (LONG lEwProjectFileID, LONG lEwProjectID, VARIANT_BOOL bShowError, EwErrorCode *errorCode)
 Check if the current user can edit the target IEwProjectFileX. More...
 
VARIANT_BOOL askForUserLogin ()
 Depending on protection type, ask for user to login if necessary. More...
 
VARIANT_BOOL resetPassword ()
 Remove the password needed to use the application. More...
 
VARIANT_BOOL askForNewPassword ()
 Prompt user to enter a new password to protect interface. More...
 
VARIANT_BOOL editCurrenUserAccount ()
 Edit properties of current user account. More...
 
VARIANT_BOOL manageUserRight ()
 Open user right managment dialog. More...
 
VARIANT_BOOL enableUserRight (VARIANT_BOOL bEnable)
 Enable/disable user right, checking if current authorization are ok. More...
 
VARIANT_BOOL isAuthorizedToAccessLibraryManager ()
 
void updateProtectionType (void)
 Check if password/user login protection is enabled. More...
 
BSTR getCurrentUserDescription ()
 get description of current user More...
 
void initUserRightFeatureDescription (void)
 Initialize description of the user right feature. More...
 

Detailed Description

Use this interface to manage the application rights.

Since
2018 SP0

Member Function Documentation

◆ askForNewPassword()

VARIANT_BOOL IEwRightsManagerX::askForNewPassword ( )

Prompt user to enter a new password to protect interface.

Returns
VARIANT_TRUE if successful

◆ askForUserLogin()

VARIANT_BOOL IEwRightsManagerX::askForUserLogin ( )

Depending on protection type, ask for user to login if necessary.

Returns
VARIANT_TRUE if successful or if user not required

◆ canEditFile()

VARIANT_BOOL IEwRightsManagerX::canEditFile ( LONG  lEwProjectFileID,
LONG  lEwProjectID,
VARIANT_BOOL  bShowError,
EwErrorCode *  errorCode 
)

Check if the current user can edit the target IEwProjectFileX.

Parameters
[in]lEwProjectFileIDFile ID to be edited
[in]lEwProjectIDProject ID to which the file belongs
[in]bShowErrorTrue to show an error dialog if the user doesn't have rights
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR: No error
  • EW_INVALID_OBJECT if object is not initialized
  • EW_OBJECT_NOT_FOUND: The file is not in the project
  • EW_PROJECT_NOTOPENED project is not opened in user interface you must call EwApplicationX::openEwProjectID
Returns
VARIANT_TRUE if the user has rights to edit the file, false otherwise

◆ editCurrenUserAccount()

VARIANT_BOOL IEwRightsManagerX::editCurrenUserAccount ( )

Edit properties of current user account.

Returns
VARIANT_TRUE if succesful

◆ enableUserRight()

VARIANT_BOOL IEwRightsManagerX::enableUserRight ( VARIANT_BOOL  bEnable)

Enable/disable user right, checking if current authorization are ok.

Parameters
[in]bEnableTrue to enable, false to disable
Returns
VARIANT_TRUE if successfully changed

◆ getCurrentUserDescription()

BSTR IEwRightsManagerX::getCurrentUserDescription ( )

get description of current user

Returns
user description or empty string if no user logged

◆ initUserRightFeatureDescription()

void IEwRightsManagerX::initUserRightFeatureDescription ( void  )

Initialize description of the user right feature.

◆ isAuthorizedToAccessLibraryManager()

VARIANT_BOOL IEwRightsManagerX::isAuthorizedToAccessLibraryManager ( )
Returns
VARIANT_TRUE if user is authorized to access library manager else VARIANT_FALSE

◆ manageUserRight()

VARIANT_BOOL IEwRightsManagerX::manageUserRight ( )

Open user right managment dialog.

Returns
VARIANT_TRUE if successful

◆ resetPassword()

VARIANT_BOOL IEwRightsManagerX::resetPassword ( )

Remove the password needed to use the application.

Returns
VARIANT_TRUE if succesful

◆ updateProtectionType()

void IEwRightsManagerX::updateProtectionType ( void  )

Check if password/user login protection is enabled.

Used to intialize the rights of the application.

Generated on Thu Aug 20 2020 08:40:18 for SOLIDWORKS Electrical API by   doxygen 1.8.18


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   SOLIDWORKS Electrical API: IEwRightsManagerX Interface Reference
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:

x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2021 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.

0.20.48