ISProviderVers.PreferredName

Description

The provider's preferred name in the selected provider version.

Syntax

object.PreferredName

Part Attribute Type Description
object Required
The object always implements the ISProviderVers interface
Restriction: This property is readonly.

Return Value

string

Example

Display the full name, preferred name and ID of the provider in the selected provider version.

sub main()

  Dim aFilter 
  Dim aProviders
  Dim aDate
  Dim aMessage

  Set aFilter = Profile.CreateProvidersFilter
  aFilter.Category = 2 'pcProvider
  aFilter.Code = "VE3"

  set aProviders = Profile.LoadProvidersByFilter(aFilter)

  aDate = #07/15/2019  11:41:59#
  aMessage = GetProviderCollectionInfo(aProviders, aDate)

  Profile.MsgBox(aMessage)
end sub


function GetProviderCollectionInfo(aProviders, aDate)
  Dim aProvider
  Dim aProviderOnDate
  Dim aInfo
   
  aInfo = ""

  for each aProvider in aProviders
    aInfo = aInfo & vbNewLine & vbNewLine & "PROVIDER: " &_
      aProvider.FullName & vbNewLine

    set aProviderOnDate = aProvider.VersionOnDate(aDate)
    if aProviderOnDate is nothing then    
      aInfo = aInfo & vbNewLine & " - " & aProvider.FullName &_
        " (" & aProvider.Id & ") " & "  -  No Version on this date"
    else            
      aInfo = aInfo & vbNewLine & "CURRENT VERSION: " & vbNewLine &_
        "Full Name: " & aProvider.FullName & vbNewLine & "ID: " & aProvider.Id &_
        vbNewLine & "Preferred Name: " & aProvider.PreferredName & vbNewLine &_
        vbNewLine & "VERSION ON DATE:  " & vbNewLine & "Full Name: " &_
        aProviderOnDate.FullName & vbNewLine & "ID: " & aProviderOnDate.Id &_
        vbNewLine & "Preferred Name: " & aProviderOnDate.PreferredName
    end if 
  next   
  GetProviderCollectionInfo = aInfo
end function  
Note:

In Profile Client v8 on User Interface Preferred Name can be found in Report > Find Objects > Provider > Provider Version > Name Preferred Name.

Version information

Added in v7.8.0