IUccCredential.Password Property

  • Article

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Gets the password associated with the credential.

Namespace: Microsoft.Office.Interop.UccApi
Assembly: Microsoft.Office.Interop.UccApi (in microsoft.office.interop.uccapi.dll)

Syntax

'Declaration
ReadOnly Property Password As String

string Password { get; }

property String^ Password {
    String^ get ();
}

/** @property */
String get_Password ()

function get Password () : String

Property Value

A value of the BSTR* (string, for a .NET application) type. After a successful return, this holds the password as part of the credential.

Remarks

The password property of the credential cannot be modified. Instead, it is used to identify the password used to authenticate a user within a given security realm. If the password must be changed, a new credential must be created to replace the existing credential in the credential cache.

Win32 COM/C++ Syntax

HRESULT get_Password
(
   BSTR* pbstrPassword
);

Note

In a Win32 application, the return value of a method or property is always an HRESULT value indicating the status of the call to the interface member. Any result of the operation is returned as a parameter marked with the [out, retval] attribute. In contrast, in a .NET application the HRESULT value indicating an error condition is returned as a COM exception and the [out, retval] parameter becomes the return value. For the UCC API-defined HRESULT values, see Trace and Handle Errors in Unified Communications Client API .

Example

The following example gets a credential out of a credential cache based on a supplied security realm name. The credential is returned to calling code if the credential password matches the password string passed as a method parameter.

private UccCredential GetCredentialForPassword(IUccCredentialCache pCredentialCache, string pRealm, string pPassword)
{
   UccCredential credential = null;

   if (pCredentialCache.TryGetCredential(pRealm, out credential))
   {
      if (credential.Password == pPassword)
      {
         return credential;
      }
      else
      {
         return null;
      }
   }
   else
   {
      return null;
   }
}

Thread Safety

All public static (Shared in Visual Basic) members of this type are thread-safe. Instance members are not guaranteed to be thread-safe.

Platforms

Development Platforms

Windows XP Professional with Service Pack 2 (SP2), Windows Server 2000 with Service Pack 4, Windows Server 2003, Windows Vista Ultimate Edition, Windows Vista Business Edition, Windows Vista Enterprise Edition

Target Platforms

See Also

Reference

IUccCredential Interface
IUccCredential Members
Microsoft.Office.Interop.UccApi Namespace