VCOM:VectorWorks:Filing:IStdFile::SetProgressListener

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:IStdFile

Set progress listener for the file operations.

The progress listener will get notified when the file read/write position changes.

virtual VCOMError VCOM_CALLTYPE SetProgressListener(
IStdFileProgressListener* pListener) = 0;

Parameters

pListener IStdFileProgressListener* The progress listener instance.

Return Value

Uses standard VCOM Error Reporting.

Return value meaning:

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

Remarks

The listener interface:

class IStdFileProgressListener
{
public:
  virtual                   ~IStdFileProgressListener()	  {}

  virtual void VCOM_CALLTYPE OnStdFileProgress(Uint64 position, Uint64 bytesCnt) = 0;
};

See Also

VCOM:VectorWorks:Filing:IFolderIdentifier | VCOM:VectorWorks:Filing:IFileIdentifier | VCOM:VectorWorks:Filing:IStdFile

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