Function Reference

_OL_ViewGet

Returns the object of the current view or a list of all views for the specified folder.

#Include <OutlookEX_GUI.au3>
_OL_ViewGet($oOL, $vFolder[, $iFlag = 0])

 

Parameters

$oOL Outlook object returned by a preceding call to _OL_Open()
$vFolder Folder object as returned by _OL_FolderAccess or full name of folder
$iFlag [optional] One of the following flags:
0 - Return all views for the current folder in a 2D-array (default)
1 - Return the object of the current view for the specified folder

 

Return Value

Success: When $iFlag = 0: One based two-dimensional array with the following properties:
    0 - Name of the view
    1 - Object of the view
    2 - Type of the view object described by the OlViewType enumeration
    3 - True if the view is a built-in Outlook view
    4 - True if a user can modify the settings of the view
    5 - Specifies the folders in which the specified view is available and the read permissions attached to the view. Described by the OlViewSaveOption enumeration
    6 - Filter for the view in DAV Searching and Locating (DASL) syntax
Success: When $iFlag = 1: Object of the current view for the folder
Failure: Returns "" and sets @error:
    1 - $vFolder has not been specified
    2 - Error accessing the specified folder. See @extended for errorcode returned by GetFolderFromID
    3 - Error accessing the folders views. @extended is set to the COM error code
    4 - Error accessing the current view of the specified folder. @extended is set to the COM error code

 

Remarks

None.

 

Related