IBDSecurity::RemoveAccount Method [C++]

Article
11/12/2009

This method is used by the Permissions module and dialog box to remove all accounts associated with the specified security identifier (SID) from the Security Definitions Tables (SDT).

Definition

[C++]

HRESULT IBDSecurity::RemoveAccount(BSTRbstrSID,
);

[Visual Basic]

Sub RemoveAccount(bstrSID As String,
)

Parameters

bstrSID[C++]
[in] A BSTR that contains the SID corresponding to the account to be removed.
bstrSID[Visual Basic]
A String that contains the SID corresponding to the account to be removed.

Return Values

[C++] This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.

[Visual Basic] None.

Error Values

[C++] This method returns S_OK (0x00000000) to indicate success and standard COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.

[Visual Basic] This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.

Remarks

This method will not typically be called from any Commerce Server Business Desk modules other than the Permissions module and dialog box.

For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.

[Visual Basic]

Example

' g_MSCSBizDeskSecurityis the global BD security object
' created in the page Global.asa.
' The request parameter "account" is used to pass the SID of account
' to be removed (from the page response_delaccount.asp).

g_MSCSBizDeskSecurity.RemoveAccount(Request("account"))

Share via