VCOM:VectorWorks:Filing:IFileIdentifier::GetAttributes

From Vectorworks Developer
Jump to navigation Jump to search

.SDK|SDK ..SDK:Types|SDK Types ..VCOM:VCOM (Vectorworks Component Object Model)|VCOM Basics ..VCOM:Class Reference|VCOM Class Reference

Description

namespace VectorWorks::Filing

Member of VCOM:VectorWorks:Filing:IFileIdentifier

Return the attributes of this file.

virtual VCOMError VCOM_CALLTYPE GetAttributes(
SAttributes& outAttributes) = 0;

Parameters

outAttributes SAttributes& Output parameter. Returns the attributes set for this file.

Return Value

Uses standard VCOM Error Reporting.

Return value meaning:

kVCOMError_NotInitialized Bad VCOM instance used to call the function.
kVCOMError_Failed Routine failed.

Remarks

The attributes are obtained inside the structure:

struct SAttributes
{
    bool  fbReadOnly;
    bool  fbHidden;
    bool  fbSystem;
    bool  fbTemporary;
    bool  fbEncrypted;
    bool  fbArchive;
    bool  fbDirectory;
    bool  fbCanRead;
    bool  fbCanWrite;
    bool  fbCanExecute;
    bool  fbCanBrowse;
};

See Also

VCOM:VectorWorks:Filing:IFolderIdentifier | VCOM:VectorWorks:Filing:IFileIdentifier | VCOM:VectorWorks:Filing:IFileChooserDialog

[[VCOM:VectorWorks:Filing:IFolderIdentifier]] | [[VCOM:VectorWorks:Filing:IFileIdentifier]] | [[VCOM:VectorWorks:Filing:IFileChooserDialog]]