IUccCredentialCache.TryGetCredential Method

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.

Determines whether the credential specified for a realm exists. The credential is returned if it exists.

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

Syntax

'Declaration
Function TryGetCredential ( _
    bstrRealm As String, _
    <OutAttribute> ByRef ppCredential As UccCredential _
) As Boolean

bool TryGetCredential (
    string bstrRealm,
    out UccCredential ppCredential
)

bool TryGetCredential (
    String^ bstrRealm, 
    [OutAttribute] UccCredential^% ppCredential
)

boolean TryGetCredential (
    String bstrRealm, 
    /** @attribute OutAttribute() */ /** @ref */ UccCredential ppCredential
)

Parameters

• bstrRealm
  A value of the BSTR (string, for a .NET application) type. This specifies the security realm of the credential.

• ppCredential
  A value of the IUccCredential** (UccCredential, for a .NET application) type. This returns the credential for the specified realm if the credential exists. It returns NULL if does not exist.

Return Value

A value of the VARIANT_BOOL* (bool, for a .NET application) type. This returns TRUE if the user credential can be found. It returns FALSE if the credential cannot be found.

Remarks

This method can be used to determine whether a specified credential exists.

Win32 COM/C++ Syntax

HRESULT TryGetCredential
(
   BSTR bstrRealm,
   IUccCredential** ppCredential,
   VARIANT_BOOL* pbFound
);

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 example returns an instance of UccCredential from the supplied credential cache based on the specified realm.

private UccCredential GetCurrentCredential(IUccCredentialCache pCredentialCache, string pRealm)
{
   UccCredential credential = null;
   if (pCredentialCache.TryGetCredential(pRealm, out credential))
   {
      return credential;
   }
   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

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