[This is preliminary documentation and is subject to change.]

Creates a new address book into the database for the currently logged in user. This method is used to create either a private address book or the address book shared by other group members.

Namespace:  OfficeClip.DBLayer.Desktop
Assembly:  OfficeClip.DBLayer (in OfficeClip.DBLayer)
Version: 8.1.1.0

Syntax

C#
public int CreateAddressBook(
	int groupId,
	int userId,
	string addressBookName,
	bool isShared
)
Visual Basic (Declaration)
Public Function CreateAddressBook ( _
	groupId As Integer, _
	userId As Integer, _
	addressBookName As String, _
	isShared As Boolean _
) As Integer
Visual C++
public:
int CreateAddressBook(
	int groupId, 
	int userId, 
	String^ addressBookName, 
	bool isShared
)

Parameters

groupId
Type: System..::.Int32
The unique id of the organization
userId
Type: System..::.Int32
The unique id of the current user
addressBookName
Type: System..::.String
Name of the address book to be created.
isShared
Type: System..::.Boolean
Flag (True/False) indicating whether the newly created address book is private or is shared with the members of the currently selected group.

Return Value

Id of the newly created address book, -1 in case of an error.

See Also