Created with HTMHelp © Sebastian Walter
Function List
_OL_BarGroupAdd
Description: Adds a group to the OutlookBar.
Return Value:
Success - 1
Failure - Returns 0 and sets @error:
1 - Error accessing the Outlookbar pane. For details please see @extended
2 - Error creating the group. For details please see @extended
Parameters:
$oOL - Outlook object returned by a preceding call to _OL_Open()
$oGroupname - Name of the group to be created
$iPosition (Optional) - Position at which the new group will be inserted in the Shortcuts pane (default = 1 = at the top of the bar)
Author: water
_OL_BarGroupDelete
Description: Deletes a group from the OutlookBar.
Return Value:
Success - 1
Failure - Returns 0 and sets @error:
1 - $vGroupname is empty
2 - Error accessing the specified group. For details please see @extended
3 - Error removing the specified group. For details please see @extended
Parameters:
$oOL - Outlook object returned by a preceding call to _OL_Open()
$vGroupname - Name or 1-based index value of the group to be deleted
Remarks: To delete a group by name isn't possible in Outlook 2002
Author: water
_OL_BarGroupGet
Description: Returns all groups in the OutlookBar.
Return Value:
Success - two-dimensional one based array with the following information:
0 - Display name of the group
1 - $OlOutlookBarViewType constant representing the view type of the group
Failure - Returns "" and sets @error:
1 - Error accessing the Outlookbar pane. For details please see @extended
Parameters:
$oOL - Outlook object returned by a preceding call to _OL_Open()
Author: water
_OL_BarShortcutAdd
Description: Adds a shortcut to a group in the OutlookBar.
Return Value:
Success - 1
Failure - Returns 0 and sets @error:
1 - Error accessing the group specified by $vGroupname. For details please see @extended
2 - Error creating the shortcut. For details please see @extended
3 - Specified icon file could not be found
4 - Error setting the icon for the created shortcut. For details please see @extended
Parameters:
$oOL - Outlook object returned by a preceding call to _OL_Open()
$vGroupname - Name or 1-based index value of the group where the shortcut will be created
$oShortcutname - Name of the shortcut to be created
$sTarget - Target of the shortcut being created. Can be an Outlook folder, filesystem folder, filesystem path or URL
$iPosition (Optional) - Position at which the new shortcut will be inserted in the group (default = 0 = first shortcut in an empty group)
$sIcon (Optional) - The path of the icon file e.g. C:\temp\sample.ico (default = no icon)
Remarks: Specify $iPosition = 1 to position a shortcut at the top of a non empty group
Author: water
_OL_BarShortcutDelete
Description: Deletes a Shortcut from the OutlookBar.
Return Value:
Success - 1
Failure - Returns 0 and sets @error:
1 - $vShortcutname is empty
2 - $vGroupname is empty
3 - Error accessing the specified group. For details please see @extended
4 - Error removing the specified Shortcut. For details please see @extended
Parameters:
$oOL - Outlook object returned by a preceding call to _OL_Open()
$vGroupname - Name or 1-based index value of the group from where the shortcut will be deleted
$vShortcutname - Name or 1-based index value of the shortcut to be deleted
Remarks: Deleting a shortcut by name isn't possible in Outlook 2002
Author: water
_OL_BarShortcutGet
Description: Returns all shortcuts of a group in the OutlookBar.
Return Value:
Success - two-dimensional one based array with the following information:
0 - Display name of the shortcut
1 - Variant indicating the target of the specified shortcut in a Shortcuts pane group
Failure - Returns "" and sets @error:
1 - $vGroup is empty
2 - Error accessing the specified group. For details please see @extended
Parameters:
$oOL - Outlook object returned by a preceding call to _OL_Open()
$vGroup - Name or 1-based index value of the group
Author: water
_OL_NavigationFolderAdd
Description: Adds navigation folders to a navigation group
Return Value:
Success - Number of processed navigation folders
Failure - Returns 0 and sets @error:
1 - $oOL is not an object
2 - Error accessing the navigation pane. @extended is set to the COM error code
3 - Error accessing the navigation module. @extended is set to the COM error code
4nnn - Error accessing the navigation groups. @extended is set to the COM error code. nnn is the index of the row in error
5nnn - The specified navigation group could not be found. @extended is set to the COM error code. nnn is the index of the row in error
6nnn - Error accessing the specified folder. @extended is set to @error as returned by _OL_FolderAccess. nnn is the index of the row in error
7nnn - Error adding the nagivation folder. @extended is set to the COM error code. nnn is the index of the row in error
8nnn - Error setting the position of the navigation folder. Must be a number and should be <= actual number of navigation folders + 1. nnn is the index of the row in error
Parameters:
$oOL - Outlook object returned by a preceding call to _OL_Open()
$aNavigationFolders - Array holding the navigation folders to be added to the navigation group. Please see Remarks for further information
$iStartIndex (Optional) - Index of the first item of $aNavigationFolders to be processed. Should be 0 or 1 (default = 0)
$iModuleType (Optional) - Type of the navigation module. Can be any of the OlNavigationModuleType enumeration (default = $olModuleCalendar)
Remarks: This function only works for Outlook 2007 and later.
The array has to have the same format as the result returned by _OL_NavigationFolderGet
(one or zero based two-dimensional array holding Navigation group, Folder name, Folder path, IsSelected?, IsRemovable?, IsSideBySide?, Position).
Folder Path needs to be in the format as expected by _OL_FolderAccess.
Author: water
Related: _OL_NavigationFolderRemove, _OL_NavigationFolderGet
_OL_NavigationFolderGet
Description: Returns information about navigation folders in a group or of all groups of a navigation module
Return Value:
Success - two-dimensional one based array with the following information:
0 - Name of the navigation group the navigation folder is a member of
1 - Displayname of the navigation folder
2 - Folderpath to the "real" folder. Is empty if you do not have the needed permission to access this information
3 - True indicates that the navigation folder is selected for display
4 - True indicates that the navigation folder can be removed from the navigation pane
5 - Indicates that the navigation folder is displayed in side-by-side (True) or overlay mode (False)
6 - Integer that represents the ordinal position of the navigation folder in the navigation pane
Failure - Returns "" and sets @error:
1 - $oOL is not an object
2 - Error accessing the navigation pane. @extended is set to the COM error code
3 - Error accessing the navigation module. @extended is set to the COM error code
4 - Error accessing the navigation groups. @extended is set to the COM error code
5 - The specified navigation group could not be found
Parameters:
$oOL - Outlook object returned by a preceding call to _OL_Open()
$iModuleType (Optional) - Type of the navigation module. Can be any of the OlNavigationModuleType enumeration (default = $olModuleCalendar)
$sNavigationGroup (Optional) - Name of the navigation group to process (default = "" = process all groups in the navigation module)
Remarks: This function only works for Outlook 2007 and later.
Author: water
Related: _OL_NavigationFolderAdd, _OL_NavigationFolderRemove
_OL_NavigationFolderRemove
Description: Removes a navigation folder from a navigation group
Return Value:
Success - 1
Failure - Returns 0 and sets @error:
1 - $oOL is not an object
2 - Error accessing the navigation pane. @extended is set to the COM error code
3 - Error accessing the navigation module. @extended is set to the COM error code
4 - Error accessing the navigation groups. @extended is set to the COM error code
5 - The specified navigation group could not be found. @extended is set to the COM error code
6 - The specified navigation folder could not be found. @extended is set to the COM error code
7 - Error removing the specified navigation folder. @extended is set to the COM error code
8 - Error accessing the navigation folder. @extended is set to the COM error code
9 - Can't remove the navigation folder. Property IsRemovable is set to False.
Parameters:
$oOL - Outlook object returned by a preceding call to _OL_Open()
$iModuleType - Type of the navigation module. Can be any of the OlNavigationModuleType enumeration exept $olModuleMail
$vNavigationGroup - Name or Index of the navigation group to be processed. Index is an integer that represents the ordinal position of the navigation group in the navigation pane
$vNavigationFolder - Name or Index of the navigation folder to be removed. Index is an integer that represents the ordinal position of the navigation folder in the navigation group
Remarks: Only removable folders, NavigationFolder objects with an IsRemovable property value set to True, can be removed
from a NavigationFolders collection.
This means that you can remove shared folders, public folders, and linked folders.
However, you must use function _OL_FolderDelete to remove any user-created folders
Author: water
Related: _OL_NavigationFolderAdd, _OL_NavigationFolderGet
_OL_NavigationGroupAdd
Description: Adds a navigation group to a navigation module
Return Value:
Success - Object of the created navigation group
Failure - Returns 0 and sets @error:
1 - $oOL is not an object
2 - $sGroupName is empty
3 - Error accessing the navigation pane. @extended is set to the COM error code
4 - Error accessing the navigation module. @extended is set to the COM error code
5 - Error accessing the navigation groups. @extended is set to the COM error code
6 - The specified navigation group could not be create. @extended is set to the COM error code
Parameters:
$oOL - Outlook object returned by a preceding call to _OL_Open()
$sGroupname - Displayname of the navigation group. Please see Remarks for further information
$iModuleType (Optional) - Type of the navigation module. Can be any of the OlNavigationModuleType enumeration exept $olModuleMail (default = $olModuleCalendar)
Remarks: This function only works for Outlook 2007 and later.
An error occurs if you add more than 50 navigation groups to a NavigationGroup collection, or if you add a NavigationGroup object to the NavigationGroup collection of a MailModule object
Author: water
Related: _OL_NavigationGroupGet, _OL_NavigationGroupRemove
_OL_NavigationGroupGet
Description: Returns information about navigation groups of a navigation module
Return Value:
Success - two-dimensional one based array with the following information:
0 - Name of the navigation group
1 - Grouptype (Integer) as described in the OlGrouptype enumeration
2 - Integer that represents the ordinal position of the navigation group in the navigation pane
Failure - Returns "" and sets @error:
1 - $oOL is not an object
2 - Error accessing the navigation pane. @extended is set to the COM error code
3 - Error accessing the navigation module. @extended is set to the COM error code
4 - Error accessing the navigation group. @extended is set to the COM error code
5 - The specified navigation group could not be found
Parameters:
$oOL - Outlook object returned by a preceding call to _OL_Open()
$iModuleType (Optional) - Type of the navigation module. Can be any of the OlNavigationModuleType enumeration (default = $olModuleCalendar)
$sNavigationGroup (Optional) - Name of the navigation group to process (default = "" = process all groups in the navigation module)
Remarks: This function only works for Outlook 2007 and later.
Author: water
Related: _OL_NavigationGroupAdd, _OL_NavigationGroupRemove
_OL_NavigationGroupRemove
Description: Removes a navigation group from a navigation module
Return Value:
Success - 1
Failure - Returns 0 and sets @error:
1 - $oOL is not an object
2 - Error accessing the navigation pane. @extended is set to the COM error code
3 - Error accessing the specified navigation module. @extended is set to the COM error code
4 - Error removing the specified navigation group. @extended is set to the COM error code
5 - The specified navigation group could not be found
6 - Error accessing a navigation group. @extended is set to the COM error code
Parameters:
$oOL - Outlook object returned by a preceding call to _OL_Open()
$iModuleType - Type of the navigation module you want to remove the navigation group from. Can be any of the OlNavigationModuleType enumeration except olModuleMail
$vNavigationGroup - Name or index of the navigation group to remove. Index is an integer that represents the ordinal position of the navigation group in the navigation pane
Remarks: The function returns an error if:
* The specified navigation group specified contains navigation folders in its NavigationFolders collection
* The GroupType property of the specified navigation group is set to olMyFoldersGroup
* The parent of the NavigationGroups collection is a MailModule object
Author: water
Related: _OL_NavigationGroupAdd, _OL_NavigationGroupGet
_OL_SelectionSet
Description: Select or unselect a single, selected or all items of the active or a selected Explorer.
Return Value:
Success - 1
Failure - Returns 0 and sets @error:
1 - $vItem is invalid. Has to be an object, a 2D array, 0 or 1
2 - Error selecting the item. @extended is set to the COM error code
3 - Error selecting all items of the view. @extended is set to the COM error code
4 - Error unselecting the item. @extended is set to the COM error code
5 - Error unselecting all items. @extended is set to the COM error code
6 - $iAction is invalid. Has to be 1 or 2
7 - Error getting item object from EntryID. @extended is set to the COM error code
Parameters:
$oOL - Outlook object returned by a preceding call to _OL_Open()
$vItem - Item to be processed. Can be:
object - Object of the item to be selected/unselected according to parameter $iAction
-1 - Select or unselect all items according to parameter $iAction
$iAction (Optional) - Specifies how to process $vItem. 1 - Select the item(s), 2 - Unselect the item(s) (default = 1)
$oExplorer (Optional) - Explorer to process (default = active Explorer)
$iBase (Optional) - If $vItem is a two-dimensional array this parameter specifies the index of the first row to process. Has to be 0 or 1 (default = 0)
$iIDColumn (Optional) - Zero based index of the column holding the EntryID or object of the item to select (default = 0)
Remarks: A selected item does not get unselected if you select it again.
You can pass the result of _OL_ItemFind to select all found items.
Author: water
_OL_ViewApply
Description: Applies a view to the Microsoft Outlook user interface of the specified folder.
Return Value:
Success - Object of the view
Failure - Returns 0 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 applying the view. @extended is set to the COM error code
5 - View does not exist or an error occurred. @extended is set to the COM error code (if any)
Parameters:
$oOL - Outlook object returned by a preceding call to _OL_Open()
$vView - Index, name or object of the view to be applied
$vFolder (Optional) - Folder object as returned by _OL_FolderAccess or full name of folder. Has to be specified when $vView is not a view object
Author: water
_OL_ViewCreate
Description: Creates a new view for the specified folder.
Return Value:
Success - Object of the created view
Failure - Returns 0 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 creating the new view. @extended is set to the COM error code
5 - View already exists or an error occurred. @extended is set to the COM error code (if any)
6 - Error saving the new view. @extended is set to the COM error code
Parameters:
$oOL - Outlook object returned by a preceding call to _OL_Open()
$sView - Name of the new view
$vFolder - Folder object as returned by _OL_FolderAccess or full name of folder
$iType (Optional) - The type of the new view. Can be any of the OlViewType enumeration (default = $olTableView)
$iSaveOption (Optional) - Specifies the permissions of the new view. Can be any of the OlViewSaveOption enumeration (default = $olViewSaveOptionThisFolderOnlyMe)
Author: water
_OL_ViewDelete
Description: Deletes a view from the specified folder.
Return Value:
Success - 1
Failure - Returns 0 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 deleting the view. @extended is set to the COM error code
5 - View does not exist or an error occurred. @extended is set to the COM error code (if any)
Parameters:
$oOL - Outlook object returned by a preceding call to _OL_Open()
$vView - Index, name or object of the view to be deleted
$vFolder (Optional) - Folder object as returned by _OL_FolderAccess or full name of folder. Has to be specified when $vView is not a view object
Author: water
_OL_ViewExists
Description: Returns True if the specified view exists.
Return Value:
Success - True
Failure - Returns False 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 - View does not exist or an error occurred. @extended is set to the COM error code (if any)
Parameters:
$oOL - Outlook object returned by a preceding call to _OL_Open()
$vView - Index or name of the view
$vFolder - Folder object as returned by _OL_FolderAccess or full name of folder
Author: water
_OL_ViewFieldAdd
Description: Adds/inserts fields to/into a view and sets the formatting.
Return Value:
Success - Object of the view
Failure - Returns 0 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 - View does not exist or an error occurred. @extended is set to the COM error code (if any)
5 - Error adding/inserting a ViewField. @extended is set to the zero-based index of the ViewField in error
6 - Error setting the Align ColumnFormat parameter for the specified ViewField. @extended is set to the zero-based index of the ViewField in error
7 - Error setting the FieldFormat ColumnFormat parameter for the specified ViewField. @extended is set to the zero-based index of the ViewField in error
8 - Error setting the Label ColumnFormat parameter for the specified ViewField. @extended is set to the zero-based index of the ViewField in error
9 - Error setting the Width ColumnFormat parameter for the specified ViewField. @extended is set to the zero-based index of the ViewField in error
10 - Error saving the new view. @extended is set to the COM error code
11 - Invalid ViewType. Fields can only be added to CardViews and TableViews
Parameters:
$oOL - Outlook object returned by a preceding call to _OL_Open()
$vView - Index, name or object of the view to be modified
$vFolder - Folder object as returned by _OL_FolderAccess or full name of folder. Has to be specified when $vView is not a view object
$aFields - two dimensional zero-based array describing the ViewFields to be added/inserted with the following columns:
0 - Name of the property (field name: displayed in the Field Chooser) to be added/inserted
1 - One-based index number where to insert the property. If empty or 0 the property will be added after the last property
2 - Align: Alignment of the ViewField column. Can be any of the OlAlign enumeration
3 - FieldFormat: Display format of the property depending on the FieldType. For details please see Remarks
4 - Label: Column label and tooltip displayed for the property
5 - Width: Approximate width (in characters) of the column
$bReset (Optional) - Removes all existing ViewFields from the View before adding the new ViewFields (default = False)
Remarks: FieldFormat: https://docs.microsoft.com/en-us/office/vba/api/outlook.columnformat.fieldformat
Author: water
_OL_ViewFontSet
Description: Sets the properties of the ViewFont object for the specified View object.
Return Value:
Success - 1
Failure - Returns 0 and sets @error:
1 - $oObject ist not an object type
2 - Error setting property Size of the object. @extended is set to the COM error code
3 - Error setting property Bold of the object. @extended is set to the COM error code
4 - Error setting property Color of the object. @extended is set to the COM error code
5 - Error setting property ExtendedColor of the object. @extended is set to the COM error code
6 - Error setting property Italic of the object. @extended is set to the COM error code
7 - Error setting property Strikethrough of the object. @extended is set to the COM error code
8 - Error setting property Underline of the object. @extended is set to the COM error code
9 - Error saving the new view. @extended is set to the COM error code
Parameters:
$oObject - Object to set the font properties for. Depending on the view type this can be one of the following:
BusinessCardView: The HeadingsFont property
CalendarView: The DayWeekFont, DayWeekTimeFont or MonthFont property
CardView: The BodyFont or HeadingsFont property
TableView: The AutoPreviewFont, ColumnFont or RowFont property
TimelineView: The ItemFont, LowerScaleFont or UpperScaleFont property
$iSize (Optional) - Size (in points) of the font
$bBold (Optional) - True if the font is bold
$iColor (Optional) - Color of the font. Can be any of the OlColor enumeration
$iExtendedColor (Optional) - Extended color of the font. Can be any of the OlCategoryColor enumeration
$bItalic (Optional) - If the font is italicized
$bStrikethrough (Optional) - If the font is struck through with a horizontal line
$bUnderline (Optional) - If the font is underlined
Remarks: The ViewFont object is used by the following objects to represent font formatting information applied to the text in various portions of a view:
The HeadingsFont property of the BusinessCardView object.
The DayWeekFont, DayWeekTimeFont, and MonthFont properties of the CalendarView object.
The BodyFont and HeadingsFont properties of the CardView object.
The AutoPreviewFont, ColumnFont, and RowFont properties of the TableView object.
The ItemFont, LowerScaleFont, and UpperScaleFont properties of the TimelineView object.
Author: water
_OL_ViewFormatRuleAdd
Description: Adds/inserts a new AutoFormat rule to a view.
Return Value:
Success - Object of the Format Rule
Failure - Returns 0 and sets @error:
1 - $vFolder has not been specified
Parameters:
$oOL - Outlook object returned by a preceding call to _OL_Open()
$vView - Index, name or object of the view to be modified
$vFolder - Folder object as returned by _OL_FolderAccess or full name of folder. Has to be specified when $vView is not a view object, els the parameter is ignored
$sName - Display name for the view (default = do not modify)
$sFilter (Optional) - String in DAV Searching and Locating (DASL) syntax that represents the current filter for the view (default = do not modify)
$iIndex (Optional) - Either the index number at which to insert the rule, or the name of a rule in the collection where the new rule is to be inserted. See Remark
$bEnabled (Optional) - Indicates whether the formatting rule is enabled (default = True)
Remarks: $iIndex: When set to ...
Author: water
_OL_ViewGet
Description: Returns the object of the current view or a list of all views 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
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
Author: water
_OL_ViewModify
Description: Modifies properties of a view.
Return Value:
Success - Object of the view
Failure - Returns 0 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 - View does not exist or an error occurred. @extended is set to the COM error code (if any)
5 - Error modifying property "Name". @extended is set to the COM error code
6 - Error modifying property "Language". @extended is set to the COM error code
7 - Error modifying property "LockUserChanges". @extended is set to the COM error code
8 - Error modifying property "Filter". @extended is set to the COM error code
9 - Error modifying property "XML". @extended is set to the COM error code
10 - Error saving the new view. @extended is set to the COM error code
Parameters:
$oOL - Outlook object returned by a preceding call to _OL_Open()
$vView - Index, name or object of the view to be modified
$vFolder (Optional) - Folder object as returned by _OL_FolderAccess or full name of folder. Has to be specified when $vView is not a view object
$sName (Optional) - Display name for the view (default = do not modify)
$sLanguage (Optional) - String that represents the language setting for the object that defines the language used in the menu (default = do not modify)
$bLockUserChanges (Optional) - Indicates whether a user can modify the settings of the current view. Use True or False (default = do not modify)
$sFilter (Optional) - String in DAV Searching and Locating (DASL) syntax that represents the current filter for the view (default = do not modify)
$sXML (Optional) - String value that specifies the XML definition of the current view (default = do not modify)
Remarks: $sLanguage: Example: "EN-US" represents the ISO code for "United States - English"
Author: water
_OL_ViewPropertyGet
Description: Returns all properties of a view.
Return Value:
Success - two-dimensional one based array with the following information:
0 - Name of the property
1 - Value of the property
2 - Type of the property (1 if the property value is an object, else 0. So you can distinguish from an empty value)
Failure - Returns 0 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 - View does not exist or an error occurred. @extended is set to the COM error code (if any)
5 - ViewType of the specified view can not be found in table $aViewProperties
Parameters:
$oOL - Outlook object returned by a preceding call to _OL_Open()
$vView - Index, name or object of the view to be queried
$vFolder (Optional) - Folder object as returned by _OL_FolderAccess or full name of folder. Has to be specified when $vView is not a view object, els the parameter is ignored
Author: water
_OL_ViewPropertySet
Description: Modifies properties of a view.
Return Value:
Success - Object of the view
Failure - Returns 0 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 - View does not exist or an error occurred. @extended is set to the COM error code (if any)
5 - Invalid format of property in $aProperties. @extended is set to the zero-based index of the property in error
6 - Invalid property name for the view type. @extended is set to the zero-based index of the property in error
7 - Error saving the new view. @extended is set to the COM error code
8 - Error setting the property. @extended is set to the zero-based index of the property in error
Parameters:
$oOL - Outlook object returned by a preceding call to _OL_Open()
$vView - Index, name or object of the view to be modified
$vFolder - Folder object as returned by _OL_FolderAccess or full name of folder. Has to be specified when $vView is not a view object, els the parameter is ignored
$aProperties - One dimensional zero-based array holding the properties to set based on the view type. Format: propertyname=propertyvalue
Remarks: Empty rows in $aProperties are ignored
Author: water
_OL_ViewSortFieldAdd
Description: Adds/inserts SortFields for a view.
Return Value:
Success - Object of the view
Failure - Returns 0 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 - View does not exist or an error occurred. @extended is set to the COM error code (if any)
5 - Error adding/inserting a SortField. @extended is set to the zero-based index of the SortField in error
6 - Error saving the new view. @extended is set to the COM error code
7 - Invalid ViewType. Fields can only be added to the following ViewTypes: BusinessCardView, CalendarView, CardView, IconView, PeopleView, TableView
Parameters:
$oOL - Outlook object returned by a preceding call to _OL_Open()
$vView - Index, name or object of the view to be modified
$vFolder - Folder object as returned by _OL_FolderAccess or full name of folder. Has to be specified when $vView is not a view object
$aSortFields - two dimensional zero-based array describing the SortFields to be added/inserted with the following columns:
0 - Name of the property (field name: displayed in the Field Chooser) to sort on
1 - One-based index number where to insert the property. If empty or 0 the property will be added after the last property
2 - IsDescending: If set to True, the property is sorted in descending order (default = False - the property is sorted in ascending order
$bReset (Optional) - Removes all existing SortFields from the View before adding the new SortFields (default = False)
Author: water