Share via


IContact::get_FileAs

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

The FileAs property gets or sets the filing string for a contact.

To get the value of the FileAs property, call the property method described here.

To set the value of the FileAs property, see the IContact::put_FileAs property method.

Syntax

HRESULT get_FileAs(
   BSTR * ppwsz
);

Parameters

  • ppwsz
    [out] Reference to the filing string. For information on the BSTR type, see BSTR.

Return Value

This method returns the standard values E_INVALIDARG, E_OUTOFMEMORY, E_UNEXPECTED, and E_FAIL, as well as the following:

  • S_OK
    The method completed successfully.

Remarks

Maximum length is 1022 characters.

Outlook Mobile automatically defaults the filing string to "LastName, FirstName".

If you update a Contact's FirstName or LastName (or CompanyName if there are no values for FirstName and LastName), Outlook Mobile automatically updates the FileAs value to match.

If you set FileAs, the new value is not overwritten until you call Save.

Requirements

Header pimstore.h
Library Pimstore.lib
Windows Embedded CE Windows CE 2.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also

Reference

IContact
Pocket Outlook Object Model Interfaces

Other Resources

Pocket Outlook Object Model Enumerations