IListManager::AddUserToMailingList Method [C++]

Article
11/12/2009

Use this method to add a user record to a mailing list.

Definition

[C++]

HRESULT IListManager::AddUserToMailingList(VARIANTlistID,
  VARIANTUserEmail,
  VARIANTUserGUID,
  VARIANTUserFmt,
  VARIANTUserLocale,
  VARIANTUserUrl);

[Visual Basic]

Sub AddUserToMailingList(listID As Variant,
  UserEmail As Variant,
  Optional UserGUID As Variant,
  Optional UserFmt As Variant,
  Optional UserLocale As Variant,
  Optional UserUrl As Variant)

Parameters

listID[C++]
[in] A VARIANT that contains the ID or name of the list.
listID[Visual Basic]
A Variant that contains ID or name of the list.
UserEmail[C++]
[in] A VARIANT that contains the e-mail address of the user.
UserEmail[Visual Basic]
A Variant that contains the e-mail address of the user.
UserGUID[C++]
[in, optional] A VARIANT that contains the ID of the user (usually a GUID).
UserGUID[Visual Basic]
A Variant that contains the ID of the user (usually a GUID).
UserFmt[C++]
[in, optional] A VARIANT that contains the message format flag. See the Remarks section for more information.
UserFmt[Visual Basic]
An optional Variant that contains the message format flag. See the Remarks section for more information.
UserLocale[C++]
[in, optional] A VARIANT that contains the locale identifier (lcid) of the preferred character set for the user.
UserLocale[Visual Basic]
An optional Variant that contains the locale identifier (lcid) of the preferred character set for the user.
UserUrl[C++]
[in, optional] A VARIANT that contains a URL used for retrieving personalized content for the user.
UserUrl[Visual Basic]
An optional Variant that contains a URL used for retrieving personalized content for the user.

[C++]

Return Values

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

Error Values

[C++] This method returns S_OK (0x00000000) to indicate success and either standard or custom COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors.

[Visual Basic] This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to either standard or custom COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors.

The following table shows the custom COM errors that this method can return.

Constant	Value	Description
E_LM_LIST_BUSY	[C++] 0x8C400008 [Visual Basic] &H8C400008	The specified list is currently busy with another operation.
E_LM_LIST_IN_FAILED_STATE	[C++] 0x8C40001D [Visual Basic] &H8C40001D	The specified list is in a FAILED state and may not be used for the operation.
E_LM_LIST_NOT_FOUND	[C++] 0x8C400006 [Visual Basic] &H8C400006	The specified list does not exist.
E_LM_MAILABLE_LIST_NO_EMAILS	[C++] 0x8C40000D [Visual Basic] &H8C40000D	The list is designated as a Mailable list but does not contain an rcp_email column.
E_LM_MUST_BE_STATIC	[C++] 0x8C400019 [Visual Basic] &H8C400019	The operation requires a static list and the specified list is dynamic.
E_LM_NOT_MAILING_LIST	[C++] 0x8C400018 [Visual Basic] &H8C400018	The operation requires a Mailing list and the specified list is not a mailing list.
E_LM_SQLERROR	[C++] 0x8C400003 [Visual Basic] &H8C400003	Error while executing SQL/ADO operation.
E_LM_USER_LIST_NO_GUIDS	[C++] 0x8C40000E [Visual Basic] &H8C40000E	The list is designated as a User list but does not contain an rcp_guid column.
OLE_E_BLANK	[C++] 0x80040007 [Visual Basic] &H80040007	The ListManager object has not been properly initialized.

[C++] 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] Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.

Remarks

The UserFmt parameter specifies the format of a message used by the Direct Mailer. The possible values are: text (1), MIME (2), and MHTML (3).

To specify that one or more of the fields should be inserted as NULL, pass VT_NULL, VT_EMPTY, or VT_ERROR as the optional parameter(s).

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