Share via

IUccCredentialCache.RemoveCredential Method

  • 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.

Removes the credential for a specified security realm.

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

Syntax

'Declaration
Sub RemoveCredential ( _
    bstrRealm As String _
)

void RemoveCredential (
    string bstrRealm
)

void RemoveCredential (
    String^ bstrRealm
)

void RemoveCredential (
    String bstrRealm
)

function RemoveCredential (
    bstrRealm : String
)

Parameters

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

Remarks

The credential cache holds one credential for a given security realm as specified by the realm parameter. This method removes that specified credential from the credential cache.

Win32 COM/C++ Syntax

HRESULT RemoveCredential
(
   BSTR bstrRealm
);

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 removes a credential from the passed credential cache based on the given realm.

private void RemoveCurrentCredential(
   IUccCredentialCache pCredentialCache, 
   string pRealm)
{
   pCredentialCache.RemoveCredential(pRealm);
}

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