ISExternalProvider.IsPreferred

Description

Returns True if the selected external provider is flagged as 'preferred'.

Syntax

object.IsPreferred

Part	Attribute	Type	Description
`object`	Required	ISExternalProvider	The `object` always implements the ISExternalProvider interface

Return Value

bool

Example

Display IsPreferred for the external provider.

Dim aExtProvider 
Dim aCode
Dim aMessage

aCode = "1"
Set aExtProvider = Profile.LoadExternalProvider(aCode)

if aExtProvider.ID = 0  then 
  aMessage = "No external provider with the specified code" 
else
  aMessage = aMessage & vbNewLine & aExtProvider.FullName &_
    " is flagged as 'preferred': " & aExtProvider.IsPreferred 
end if
 
Profile.MsgBox(aMessage)

Note:

In Profile Client v8 on User Interface the Preferred checkbox can be checked in Organisation > External Providers > Basic > General.

Version information

Added in v7.8.0