View source for VCOM:VectorWorks:Filing:IFileIdentifier

{{LocationMain|category=LocationVCOM|specific=}}
__TOC__
<vwDoc>

-----------------------------------------------------------------------------------------------------------
<desc>
namespace <code>VectorWorks::Filing</code>

Instance of this interface represent one file in the OS.

The file is not required to exist for the instance to exist.
</desc>

-----------------------------------------------------------------------------------------------------------
<interface>
<code lang="cpp">
// ----------------------------------------------------------------------------------------------------
// {B4B088B1-3793-11DB-9C35-00508D5E9851}
static const VWIID IID_FileIdentifier = { 0xB4B088B1, 0x3793, 0x11DB, { 0x9C, 0x35, 0x00, 0x50, 0x8D, 0x5E, 0x98, 0x51 } };

class IFileIdentifier : public IVWUnknown
{
public:
  virtual VCOMError VCOM_CALLTYPE Set(const TXString& fullPath) = 0;
  virtual VCOMError VCOM_CALLTYPE Set(EFolderSpecifier folderSpec, bool bUserFolder, const TXString& fileName) = 0;
  virtual VCOMError VCOM_CALLTYPE Set(IFolderIdentifier* pFolderID, const TXString& fileName) = 0;
  virtual VCOMError VCOM_CALLTYPE Clear() = 0;
  virtual VCOMError VCOM_CALLTYPE IsSet() = 0;
  virtual VCOMError VCOM_CALLTYPE ExistsOnDisk(bool& outValue) = 0;
  virtual VCOMError VCOM_CALLTYPE GetFileFullPath(TXString& outPath, ETXStringEncoding txEncoding = eDefaultPathEncoding) = 0;
  virtual VCOMError VCOM_CALLTYPE GetFileName(TXString& outName) = 0;
  virtual VCOMError VCOM_CALLTYPE SetFileName(const TXString& name) = 0;
  virtual VCOMError VCOM_CALLTYPE GetFileExtension(TXString& outExtension) = 0;
  virtual VCOMError VCOM_CALLTYPE SetFileExtension(const TXString& extension) = 0;
  virtual VCOMError VCOM_CALLTYPE GetFileNameWithoutExtension(TXString& outName) = 0;
  virtual VCOMError VCOM_CALLTYPE GetFolder(IFolderIdentifier** ppOutParentFolderID) = 0;
  virtual VCOMError VCOM_CALLTYPE GetAttributes(SAttributes& outAttributes) = 0;
  virtual VCOMError VCOM_CALLTYPE SetAttributes(const SAttributes& attributes) = 0;
  virtual VCOMError VCOM_CALLTYPE DeleteOnDisk() = 0;
  virtual VCOMError VCOM_CALLTYPE RenameOnDisk(const TXString& newName) = 0;
  virtual VCOMError VCOM_CALLTYPE DuplicateOnDisk(IFileIdentifier *pDestFileID, bool bOverwrite) = 0;
  virtual VCOMError VCOM_CALLTYPE LaunchInOS() = 0;
  virtual VCOMError VCOM_CALLTYPE RevealInOS() = 0;
  virtual VCOMError VCOM_CALLTYPE FormatFilename(TXString& formatName, Uint16 maxCharsWithoutSpace) = 0;
};</code>
</interface>

-----------------------------------------------------------------------------------------------------------
<members>
<lineList ident=1>
<line>
[[VCOM:VectorWorks:Filing:IFileIdentifier::Set|Set]]
Set file definition.
</line>
<line>
[[VCOM:VectorWorks:Filing:IFileIdentifier::Clear|Clear]]
Clear this file definition so it contains invalid path.
</line>
<line>
[[VCOM:VectorWorks:Filing:IFileIdentifier::IsSet|IsSet]]
Determine if this file definition contains valid path.
</line>
<line>
[[VCOM:VectorWorks:Filing:IFileIdentifier::ExistsOnDisk|ExistsOnDisk]]
Determines if this file exist on the disk.
</line>
<line>
[[VCOM:VectorWorks:Filing:IFileIdentifier::GetFileFullPath|GetFileFullPath]]
Returns the full OS path of the file. In VW 2016, you can specify the encoding of outPath by specifying the optional encoding parameter. The default on Mac is UTF8, on Windows is language-specific Windows encoding. ETXStringEncoding enum class is defined in "GSString.X.h".
</line>
<line>
[[VCOM:VectorWorks:Filing:IFileIdentifier::GetFileName|GetFileName]]
Returns the file name.
</line>
<line>
[[VCOM:VectorWorks:Filing:IFileIdentifier::SetFileName|SetFileName]]
Set new name of the file definition.
</line>
<line>
[[VCOM:VectorWorks:Filing:IFileIdentifier::GetFileExtension|GetFileExtension]]
Returns the extension of the file.
</line>
<line>
[[VCOM:VectorWorks:Filing:IFileIdentifier::SetFileExtension|SetFileExtension]]
Set new extension of the file.
</line>
<line>
[[VCOM:VectorWorks:Filing:IFileIdentifier::GetFileNameWithoutExtension|GetFileNameWithoutExtension]]
Return the file name without extension
</line>
<line>
[[VCOM:VectorWorks:Filing:IFileIdentifier::GetFolder|GetFolder]]
Returns the parent folder of this file.
</line>
<line>
[[VCOM:VectorWorks:Filing:IFileIdentifier::GetAttributes|GetAttributes]]
Returns the OS attributes of this file.
</line>
<line>
[[VCOM:VectorWorks:Filing:IFileIdentifier::SetAttributes|SetAttributes]]
Set new OS attributes of this file.
</line>
<line>
[[VCOM:VectorWorks:Filing:IFileIdentifier::DeleteOnDisk|DeleteOnDisk]]
Delete this file on the disk.
</line>
<line>
[[VCOM:VectorWorks:Filing:IFileIdentifier::RenameOnDisk|RenameOnDisk]]
Rename the file on the disk.
</line>
<line>
[[VCOM:VectorWorks:Filing:IFileIdentifier::DuplicateOnDisk|DuplicateOnDisk]]
Duplicate the file on the disk.
</line>
<line>
[[VCOM:VectorWorks:Filing:IFileIdentifier::LaunchInOS|LaunchInOS]]
Launch the file using the OS.
</line>
<line>
[[VCOM:VectorWorks:Filing:IFileIdentifier::RevealInOS|RevealInOS]]
Reveal the file inside OS window.
</line>
<line>
[[VCOM:VectorWorks:Filing:IFileIdentifier::FormatFilename|FormatFilename]]
Format passed file name not to exceed specified amount of characters.
</line>
<line>
[[VCOM:VectorWorks:Filing:IFileIdentifier::ValidateName|ValidateName]]
<needs info>
</line>
</lineList>
</members>

-----------------------------------------------------------------------------------------------------------
<remark>
You should use [[VCOM:VectorWorks:Filing:IFileIdentifier::Set|Set]] members first to specify the instance's file. There are VectorWorks predefined folders which can be accessed through the enumeration values from EFolderSpecifier provided by the SDK in file 'FolderSpecifiers.h' 

The most common used values are: 

<pre>
kApplicationFolder
kExternalsFolder
</pre>

There is predefined type for [[VCOM:VCOMPtr|smart VCOM pointer VCOMPtr]] to IFileIdentifier interface:

<code lang="cpp">
typedef VCOMPtr< IFileIdentifier >  IFileIdentifierPtr;
</code>
</remark>

-----------------------------------------------------------------------------------------------------------
<sample>
Create an instance and set it to refer to particular folder inside Plug-ins folder:

<code lang="cpp">
using namespace VectorWorks::Filing;

VCOMPtr< IFileIdentifier >  pMyFile ( IID_FileIdentifier );
if ( pMyFile && VCOM_SUCCEEDED( pMyFile->Set( kExternalsFolder, "SubFolder/fileName.txt" ) ) {
   // ...
}
</code>
</sample>

-----------------------------------------------------------------------------------------------------------
<version>
Available from: VectorWorks 12
</version>

-----------------------------------------------------------------------------------------------------------
<seeAlso>
[[VCOM:VCOMPtr]] | [[VCOM:VectorWorks:Filing:IFileChooserDialog]] | [[VCOM:VectorWorks:Filing:IFolderIdentifier]]
</seeAlso>

</vwDoc>

[[Category:VCOM:VectorWorks:Filing|FileIdentifier]]