Class MFieldFileNameInfo

MFieldFileNameInfo

Support

Supported from 5.0

Description

Specifies the mixin protocol for evaluating a filename field. It defines a single pure virtual function, UpdateFieldFileName(). You should implement this function in a concrete derived class, then pass an object of the derived class to the filename field (using CFileNameField::SetFileNameInfo()) before the field can be evaluated.

Defined in MFieldFileNameInfo:
UpdateFieldFileName()

virtual TInt UpdateFieldFileName(TPtr& aValueText)const=0;

Description

Implementations of this function should set aValueText to the current document's filename, if the buffer is large enough. If not, the function should return the length which is required to hold the filename.

Parameters

TPtr& aValueText Descriptor which on return contains the document's filename.

Return value

TInt Zero if aValueText is long enough to hold the filename. Otherwise, the length of the buffer which is required to hold the filename.