Use this interface to manage file inside a project. More...

Inheritance diagram for IEwProjectFileX:

Public Member Functions
IEwProjectLocationX	getEwProjectLocation (EwErrorCode *errorCode)
	IEwProjectLocationX associated with the file. More...

BSTR	getFilePath (EwErrorCode *errorCode)
	Return the file path. More...

EwErrorCode	lock ()
	Lock the file so no one connected to the collaborative server can edit or delete it. More...

EwErrorCode	unlock ()
	Unlock the file. More...

EwFileType	getFileType ()

LONG	getPosition (EwErrorCode *errorCode)
	Get the position of files inside a book/folder. More...

LONG	getEwProjectBookID (EwErrorCode *errorCode)
	Get the ID of the book containing this file. More...

LONG	getEwProjectFolderID (EwErrorCode *errorCode)
	Get the ID of the folder containing this file. More...

EwErrorCode	setEwProjectBookID (LONG lID)
	Set the Book ID of this file. More...

EwErrorCode	setEwProjectFolderID (LONG lID)
	Set the folder ID as parent for this file. More...

VARIANT_BOOL	isOpen (EwErrorCode *errorCode)
	Return true if the project file is open. More...

EwErrorCode	open ()
	Open the project file. More...

EwErrorCode	close ()
	Close the project file. More...

EwErrorCode	setFileType (EwFileType eFileType)
	Set the file type of the current project file. More...

EwErrorCode	setOriginalFilePath (BSTR strFilePath, VARIANT_BOOL bAsShortCut)
	Specify the path of the file to add in the project. More...

BSTR	getTargetFilePath (EwErrorCode *errorCode)
	Return the path to a file not only a reference to a *.lnk. More...

VARIANT_BOOL	isLockByMe (EwErrorCode *errorCode)
	Return true if the project file is lock by me. More...

VARIANT_BOOL	isLockedByAnother (EwErrorCode *errorCode)
	Return true if the project file is lock by another. More...

IEwProjectMultilingualTextX	newEwProjectMultilingualText (EwErrorCode *errorCode)
	Create a multilingual text associated with this file. More...

long	getLocationID (EwErrorCode *errorCode)
	Get the ID of EwProjectLocationX associated to the file. More...

EwErrorCode	setLocationID (long lID, VARIANT_BOOL bChangeInComponent)
	Set the EwProjectLocationX by ID associated to the file. More...

long	getFunctionID (EwErrorCode *errorCode)
	Get the ID of EwProjectFunctionX associated to the file. More...

EwErrorCode	setFunctionID (long lID, VARIANT_BOOL bChangeInComponent)
	Set the EwProjectFunctionX ID associated to the file. More...

VARIANT_BOOL	canInsertSymbol (EwErrorCode *errorCode)
	Check if the current file is compatible to insert a symbol. More...

IEwProjectSymbolX	newEwProjectSymbolFromSymbolType (EwSymbolType eEwSymbolType, EwErrorCode *errorCode)
	Create a symbol according to this file and symbol type. More...

Public Member Functions inherited from IEwProjectTagObjectX
EwErrorCode	setUserData (LONG nUserDataNumber, BSTR strValue)
	Set user data of the object. More...

BSTR	getUserData (LONG nUserDataNumber, EwErrorCode *errorCode)
	Get user data of the object. More...

EwErrorCode	setTranslatedData (LONG nUserDataNumber, BSTR strLanguage, BSTR strValue)
	Set the value of a translated text. More...

BSTR	getTranslatedData (LONG nUserDataNumber, BSTR strLanguage, EwErrorCode *errorCode)
	Get the value of a translated text. More...

BSTR	getTag (EwErrorCode *errorCode)
	Get the mark of this object. More...

EwErrorCode	setTag (BSTR strValue)
	Set the mark of this object. More...

BSTR	getTagRoot (EwErrorCode *errorCode)
	Get the mark root of this object. More...

EwErrorCode	setTagRoot (BSTR strValue)
	Set the mark root of this object. More...

EwTagMode	getTagMode (EwErrorCode *errorCode)
	Get the mark mode of this object. More...

EwErrorCode	setTagMode (EwTagMode eTagMode)
	Set the mark mode of this object. More...

long	getTagNumber (EwErrorCode *errorCode)
	Get the mark number of this object. More...

EwErrorCode	setTagNumber (long lValue)
	Set the mark number of this object. More...

EwErrorCode	setNextTagNumber ()
	Set the next number to have a unique mark. More...

VARIANT_BOOL	isTagUnique (EwErrorCode *errorCode)
	Returns true or false if mark is unique. More...

IEwObjectX	duplicate (EwErrorCode *errorCode)
	Duplicate current project object. More...

BSTR	getDescription (BSTR strLanguage, EwErrorCode *errorCode)
	Get the description associated to the object. More...

EwErrorCode	setDescription (BSTR strLanguage, BSTR strDescription)
	Set the description associated to the object. More...

Public Member Functions inherited from IEwObjectX
LONG	getID ()

Public Member Functions inherited from IEwObjectBaseX
EwErrorCode	insert ()
	Insert the object inside the current project. More...

EwErrorCode	remove ()
	Remove the object from the current project. More...

EwErrorCode	update ()
	Update the object inside the current project. More...

Detailed Description

Use this interface to manage file inside a project.

Since: 2018 SP0

Member Function Documentation

◆ canInsertSymbol()

VARIANT_BOOL IEwProjectFileX::canInsertSymbol ( EwErrorCode * errorCode )

Check if the current file is compatible to insert a symbol.

Parameters

[out]

errorCode

EwErrorCode enum type, can be:

EW_UNDEFINED_ERROR if another error occurred
EW_INVALID_OBJECT if object is not initialized
EW_PROJECT_NOTOPENED if project not opened.
EW_NO_ERROR if no error detected

Returns: VARIANT_TRUE if the user has rights to insert symbol on this current file, VARIANT_FALSE otherwise

◆ close()

EwErrorCode IEwProjectFileX::close ( )

Close the project file.

Since: 2019 SP3.

Returns

EwErrorCode enum type, can be:Error code:

EW_UNDEFINED_ERROR if another error occurred.
EW_CANNOT_CLOSE if cannot close the project file.
EW_INVALID_OBJECT if object base not initialized.
EW_PROJECT_NOTOPENED if project not opened.
EW_NO_ERROR if no error detected.

◆ getEwProjectBookID()

LONG IEwProjectFileX::getEwProjectBookID ( EwErrorCode * errorCode )

Get the ID of the book containing this file.

Since: 2019.

Parameters

[out]

errorCode

EwErrorCode enum type, can be:

EW_UNDEFINED_ERROR if another error occurred.
EW_INVALID_OBJECT if object base not initialized.
EW_PROJECT_NOTOPENED if project not opened.
EW_NO_ERROR if no error detected.

Returns: the ID of the book containing this folder.

◆ getEwProjectFolderID()

LONG IEwProjectFileX::getEwProjectFolderID ( EwErrorCode * errorCode )

Get the ID of the folder containing this file.

If the file doesn't have parent folder it returns -1.

Since: 2019

Parameters

[out]

errorCode

EwErrorCode enum type, can be:

EW_UNDEFINED_ERROR if another error occurred.
EW_INVALID_OBJECT if object base not initialized.
EW_PROJECT_NOTOPENED if project not opened.
EW_NO_ERROR if no error detected.

Returns: the ID of the folder containing this folder.

◆ getEwProjectLocation()

IEwProjectLocationX IEwProjectFileX::getEwProjectLocation ( EwErrorCode * errorCode )

IEwProjectLocationX associated with the file.

Parameters

[out]

errorCode

EwErrorCode enum type, can be:

EW_UNDEFINED_ERROR if another error occurred.
EW_OBJECT_NOT_FOUND if object not found.
EW_INVALID_OBJECT if object base not initialized.
EW_PROJECT_NOTOPENED if project not opened.
EW_NO_ERROR if no error detected.

Returns: IEwProjectLocationX pointer to the associated location. NULL if there is an error.

◆ getFilePath()

BSTR IEwProjectFileX::getFilePath ( EwErrorCode * errorCode )

Return the file path.

Parameters

[out]

errorCode

EwErrorCode enum type, can be:

EW_UNDEFINED_ERROR if another error occurred.
EW_INVALID_OBJECT if object base not initialized.
EW_PROJECT_NOTOPENED if project not opened.
EW_NO_ERROR if no error detected.

Returns: the file path.

◆ getFileType()

EwFileType IEwProjectFileX::getFileType ( )

Returns: Get an EwFileType enum file type. return kUnknowFileType if the object is invalid.

◆ getFunctionID()

long IEwProjectFileX::getFunctionID ( EwErrorCode * errorCode )

Get the ID of EwProjectFunctionX associated to the file.

Since: 2024 SP0

Parameters

[out]

errorCode

EwErrorCode enum type, can be:

EW_UNDEFINED_ERROR if another error occurred.
EW_INVALID_OBJECT if object base not initialized.
EW_PROJECT_NOTOPENED if project not opened.
EW_NO_ERROR if no error detected.

Returns: ID of the associated function. -1 if no function associated.

◆ getLocationID()

long IEwProjectFileX::getLocationID ( EwErrorCode * errorCode )

Get the ID of EwProjectLocationX associated to the file.

Since: 2024 SP0

Parameters

[out]

errorCode

EwErrorCode enum type, can be:

EW_UNDEFINED_ERROR if another error occurred.
EW_INVALID_OBJECT if object base not initialized.
EW_PROJECT_NOTOPENED if project not opened.
EW_NO_ERROR if no error detected.

Returns: ID of the associated function. -1 if no location associated.

◆ getPosition()

LONG IEwProjectFileX::getPosition ( EwErrorCode * errorCode )

Get the position of files inside a book/folder.

Since: 2018 SP3.

Parameters

[out]

errorCode

EwErrorCode enum type, can be:

EW_UNDEFINED_ERROR if another error occurred.
EW_INVALID_OBJECT if object base not initialized.
EW_PROJECT_NOTOPENED if project not opened.
EW_NO_ERROR if no error detected.

Returns: the position of the file in the book/folder.

◆ getTargetFilePath()

BSTR IEwProjectFileX::getTargetFilePath ( EwErrorCode * errorCode )

Return the path to a file not only a reference to a *.lnk.

Since: 2020 SP1.

Parameters

[out]

errorCode

EwErrorCode enum type, can be:

EW_UNDEFINED_ERROR if another error occurred.
EW_INVALID_OBJECT if object base not initialized.
EW_PROJECT_NOTOPENED if project not open.
EW_FILE_NOT_FOUND if path file not initialise.
EW_NO_ERROR if no error detected.

Returns: file path of projectFile.

◆ isLockByMe()

VARIANT_BOOL IEwProjectFileX::isLockByMe ( EwErrorCode * errorCode )

Return true if the project file is lock by me.

Since: 2020 SP

Parameters

[out]

errorCode

EwErrorCode enum type, can be:

EW_UNDEFINED_ERROR if another error occurred.
EW_INVALID_OBJECT if object base not initialized.
EW_PROJECT_NOTOPENED if project not open.
EW_NO_ERROR if no error detected.

Returns: true if the project file is lock by me.

◆ isLockedByAnother()

VARIANT_BOOL IEwProjectFileX::isLockedByAnother ( EwErrorCode * errorCode )

Return true if the project file is lock by another.

Since: 2020 SP4

Parameters

[out]

errorCode

EwErrorCode enum type, can be:

EW_UNDEFINED_ERROR if another error occurred.
EW_INVALID_OBJECT if object base not initialized.
EW_PROJECT_NOTOPENED if project not open.
EW_NO_ERROR if no error detected.

Returns: true if the project file is lock by another.

◆ isOpen()

VARIANT_BOOL IEwProjectFileX::isOpen ( EwErrorCode * errorCode )

Return true if the project file is open.

Since: 2019 SP3

Parameters

[out]

errorCode

EwErrorCode enum type, can be:

EW_UNDEFINED_ERROR if another error occurred.
EW_INVALID_OBJECT if object base not initialized.
EW_PROJECT_NOTOPENED if project not open.
EW_NO_ERROR if no error detected.

Returns: true if the project file is opened.

◆ lock()

EwErrorCode IEwProjectFileX::lock ( )

Lock the file so no one connected to the collaborative server can edit or delete it.

Returns

EwErrorCode enum type, can be:Error code:

EW_UNDEFINED_ERROR if another error occurred.
EW_INVALID_OBJECT if object base not initialized.
EW_PROJECT_NOTOPENED if project not opened.
EW_NO_ERROR if no error detected.

◆ newEwProjectMultilingualText()

IEwProjectMultilingualTextX IEwProjectFileX::newEwProjectMultilingualText ( EwErrorCode * errorCode )

Create a multilingual text associated with this file.

Since: 2023 SP0.

Parameters

[out]

errorCode

EwErrorCode enum type, can be:

EW_UNDEFINED_ERROR if another error occurred.
EW_INVALID_OBJECT if object base not initialized.
EW_PROJECT_NOTOPENED if project not opened.
EW_INVALID_FILE if this file is not a good type to insert multilingual text.
EW_NO_ERROR if no error detected.

◆ newEwProjectSymbolFromSymbolType()

IEwProjectSymbolX IEwProjectFileX::newEwProjectSymbolFromSymbolType	(	EwSymbolType	eEwSymbolType,
		EwErrorCode *	errorCode
	)

Create a symbol according to this file and symbol type.

Since: 2025 SP1.

Parameters

[in]	eEwSymbolType	the symbol's type to insert.
[out]	errorCode	EwErrorCode enum type, can be: EW_NO_ERROR if no error detected. EW_UNDEFINED_ERROR if another error occurred. EW_INVALID_FILE if this file is not a good type to insert Symbol. EW_INVALID_OBJECT if object base not initialized. EW_INVALID_OBJECT if current object is not inserted. EW_BAD_INPUTS if the symbol cannot be created from the symbol type for the kind of file. EW_PROJECT_NOTOPENED if project not opened. EW_NO_ERROR if no error detected.

◆ open()

EwErrorCode IEwProjectFileX::open ( )

Open the project file.

Since: 2019 SP3.

Returns

EwErrorCode enum type, can be:Error code:

EW_UNDEFINED_ERROR if another error occurred.
EW_CANNOT_OPEN if cannot open the project file.
EW_INVALID_OBJECT if object base not initialized.
EW_PROJECT_NOTOPENED if project not opened.
EW_NO_ERROR if no error detected.

◆ setEwProjectBookID()

EwErrorCode IEwProjectFileX::setEwProjectBookID ( LONG lID )

Set the Book ID of this file.

The parent folder ID is set to -1. If the Book and the Folder are not specified, the default book is used. Can be used only before calling insert.

Since: 2019

Parameters

[in] lID ID of the book to set.

Returns

EwErrorCode enum type, can be:

EW_UNDEFINED_ERROR if another error occurred.
EW_OBJECT_NOT_FOUND if the book ID does not exist.
EW_BAD_INPUTS if the new value is < 1 or this file is already inserted.
EW_INVALID_OBJECT if object base not initialized.
EW_PROJECT_NOTOPENED if project not opened.
EW_NO_ERROR if no error detected.

◆ setEwProjectFolderID()

EwErrorCode IEwProjectFileX::setEwProjectFolderID ( LONG lID )

Set the folder ID as parent for this file.

Book ID of the file will also be updated if the book of the new parent folder is different from the one already define. If the Book and the Folder are not specified, the default book is used. Can be used only before calling insert.

Since: 2019.

Parameters

[in] lID ID of the new parent folder.

Returns

EwErrorCode enum type, can be:

EW_UNDEFINED_ERROR if another error occurred.
EW_INVALID_OBJECT if object base not initialized.
EW_BAD_INPUTS if the new value is < 1 or this file is already inserted.
EW_OBJECT_NOT_FOUND if folder associated with this ID doesn't exist.
EW_PROJECT_NOTOPENED if project not opened.
EW_NO_ERROR if no error detected.

◆ setFileType()

EwErrorCode IEwProjectFileX::setFileType ( EwFileType eFileType )

Set the file type of the current project file.

If the file is already inserted, only kFileFolio to kFileMixed or kFileLineDiagram to kFileMixed enum are allowed.

Since: 2020 SP0.

Parameters

[in] eFileType The new file type.

Returns

EwErrorCode enum type, can be:

EW_BAD_INPUTS if eFileType is a non valid File enum (kUnknowFileType or kFileMax).
EW_INVALID_OBJECT if object base not initialized.
EW_PROJECT_NOTOPENED if project not opened.
EW_NO_ERROR if no error detected.

◆ setFunctionID()

EwErrorCode IEwProjectFileX::setFunctionID	(	long	lID,
		VARIANT_BOOL	bChangeInComponent
	)

Set the EwProjectFunctionX ID associated to the file.

Since: 2024 SP0

Parameters

[in]	lID	id of new function to set.
[in]	bChangeInComponent	if is true change function of compoment in file;

Returns

errorCode EwErrorCode enum type, can be:

EW_UNDEFINED_ERROR if another error occurred.
EW_INVALID_OBJECT if object base not initialized.
EW_PROJECT_NOTOPENED if project not opened.
EW_OBJECT_NOT_FOUND if EwProjectFunctionX not found.
EW_NO_ERROR if no error detected.

◆ setLocationID()

EwErrorCode IEwProjectFileX::setLocationID	(	long	lID,
		VARIANT_BOOL	bChangeInComponent
	)

Set the EwProjectLocationX by ID associated to the file.

Since: 2024 SP0

Parameters

[in]	lID	id of new location to set.
[in]	bChangeInComponent	if is true change location of compoment in file;

Returns

errorCode EwErrorCode enum type, can be:

EW_UNDEFINED_ERROR if another error occurred
EW_INVALID_OBJECT if object is not initialized
EW_BAD_INPUTS if the ID of EwProjectLocationX cannot be found.
EW_NO_ERROR if no error detected

◆ setOriginalFilePath()

EwErrorCode IEwProjectFileX::setOriginalFilePath	(	BSTR	strFilePath,
		VARIANT_BOOL	bAsShortCut
	)

Specify the path of the file to add in the project.

Use this method to add an existing file or a shortcut to the project. When calling this method the file type is also updated to kOther or kFileAppendixDxfDwg for dwg and dxf files. It doesn't work on already existing files.

Since: 2020 SP0.

Parameters

[in]	strFilePath	Full file path.
[in]	bAsShortCut	set to true to specify that the file must be added as a shortcut.

Returns

EwErrorCode enum type, can be:

EW_UNDEFINED_ERROR if another error occurred.
EW_INVALID_OBJECT if object base not initialized.
EW_FILE_NOT_FOUND if file path does not exist.
EW_OBJECT_ALREADY_INSERTED if the file is already inserted and cannot be modified by this interface. Create a new one to do this.
EW_PROJECT_NOTOPENED if project not opened.
EW_NO_ERROR if no error detected.

◆ unlock()

EwErrorCode IEwProjectFileX::unlock ( )

Unlock the file.

Returns

EwErrorCode enum type, can be:Error code:

EW_UNDEFINED_ERROR if another error occurred.
EW_INVALID_OBJECT if object base not initialized.
EW_PROJECT_NOTOPENED if project not opened.
EW_NO_ERROR if no error detected.


*Email:
Subject:		Feedback on Help Topics
Page:		SOLIDWORKS Electrical API: IEwProjectFileX 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

Public Member Functions

Detailed Description

Member Function Documentation

◆ canInsertSymbol()

◆ close()

◆ getEwProjectBookID()

◆ getEwProjectFolderID()

◆ getEwProjectLocation()

◆ getFilePath()

◆ getFileType()

◆ getFunctionID()

◆ getLocationID()

◆ getPosition()

◆ getTargetFilePath()

◆ isLockByMe()

◆ isLockedByAnother()

◆ isOpen()

◆ lock()

◆ newEwProjectMultilingualText()

◆ newEwProjectSymbolFromSymbolType()

◆ open()

◆ setEwProjectBookID()

◆ setEwProjectFolderID()

◆ setFileType()

◆ setFunctionID()

◆ setLocationID()

◆ setOriginalFilePath()

◆ unlock()