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

Gets all the Address Books for the currently logged in user. This method returns both the private address books for the user and also the shared address books belonging to the currently selected group.

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

Syntax

C#
public DataSet GetAddressBook(
	int userId,
	int groupId
)
Visual Basic (Declaration)
Public Function GetAddressBook ( _
	userId As Integer, _
	groupId As Integer _
) As DataSet
Visual C++
public:
DataSet^ GetAddressBook(
	int userId, 
	int groupId
)

Parameters

userId
Type: System..::.Int32
groupId
Type: System..::.Int32

Return Value

SqlDataReader containing all the information related to the address books visible to the user. The SqlDataReader has the following columns.
  • groupId (System.Int32)Id of the address book.
  • gName (System.String)Name of the address book.
  • isPrivate (System.String)Flag (Y/N) indicating whether this address book is a private address book or is shared by the currently selected group.
  • CreatedBy (System.String)Name of the user who created this address book.
  • CreatedTimestamp (System.DateTime)Date and time when this address book was created.

See Also