MFieldFileNameInfo Class Reference

#include <fldbltin.h>

class MFieldFileNameInfo

Public Member Functions
pure virtual TInt	UpdateFieldFileName(TPtr &)

Detailed Description

Specifies the mixin protocol for evaluating a filename field.

You should implement the UpdateFieldFileName() 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.

Member Function Documentation

UpdateFieldFileName ( TPtr & )

TInt

UpdateFieldFileName

(

TPtr &

aValueText

)

const [pure virtual]

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.

Parameter	Description
aValueText	Descriptor which on return contains the document's filename.

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