Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

AFCollectiveMember.SetCredentialsAccount Method

  • Last UpdatedNov 18, 2025
  • 3 minute read
AFCollectiveMember.SetCredentialsAccount Method

Note: This API is now obsolete.

Set the account used to by the collective member to access primary server.

Namespace:  OSIsoft.AF.Collective
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

[ObsoleteAttribute("PI AF Servers 2.3 or later use certificates for authenticating between collective members.")]
public void SetCredentialsAccount(
	string name,
	SecureString password
)
<ObsoleteAttribute("PI AF Servers 2.3 or later use certificates for authenticating between collective members.")>
Public Sub SetCredentialsAccount ( 
	name As String,
	password As SecureString
)

Dim instance As AFCollectiveMember
Dim name As String
Dim password As SecureString

instance.SetCredentialsAccount(name, 
	password)
public:
[ObsoleteAttribute(L"PI AF Servers 2.3 or later use certificates for authenticating between collective members.")]
void SetCredentialsAccount(
	String^ name, 
	SecureString^ password
)
[<ObsoleteAttribute("PI AF Servers 2.3 or later use certificates for authenticating between collective members.")>]
member SetCredentialsAccount : 
        name : string * 
        password : SecureString -> unit 

Parameters

name
Type: SystemString
The account name used to access the primary server from the collective member. Specify to clear this setting so the account that the collective member is running under is used to access the primary server.
password
Type: System.SecuritySecureString
The account password for the account name used to access the primary server from the collective member. If name is , then this parameter is ignored.

Remarks

This method sets the account that the collective member uses when accessing the primary server. If not specified, then the account that the server is running under is used. You only need to specify this property if the account that the server is running under does not have access to the primary server.
Important note Important
The CredentialsAccountName and password are not used for collective members containing a PI AF Server 2.3 or later. PI AF Servers 2.3 or later use certificates for authenticating between collective members.

Version Information

AFSDK

Supported in: 2.7.5, 2.7, 2.6, 2.5, 2.4
Obsolete (compiler warning) in 3.1.1
Obsolete (compiler warning) in 3.1.0
Obsolete (compiler warning) in 3.0.2
Obsolete (compiler warning) in 3.0.1
Obsolete (compiler warning) in 3.0.0
Obsolete (compiler warning) in 2.10.11
Obsolete (compiler warning) in 2.10.5
Obsolete (compiler warning) in 2.10.0
Obsolete (compiler warning) in 2.10
Obsolete (compiler warning) in 2.9.5
Obsolete (compiler warning) in 2.9
Obsolete (compiler warning) in 2.8.5
Obsolete (compiler warning) in 2.8

See Also

In This Topic
TitleResults for “How to create a CRG?”Also Available in