File Name
Syntax
BrowseNBPeople(REF peoID: INTEGER)
Parameters
peoID - ID of person selected
Returns
Nothing
Side Effects
None
Description
This procedure will begin the browsenb event with the people dialog box.
Dialog Forms Called
people.dfc[peoplenotebook]
File Name
Syntax
BrowsePeople
Parameters
None
Returns
Nothing
Side Effects
None
Description
This procedure is initiated by the browse people system action. It will begin the peoplefind event with the people search dialog box.
Dialog Forms Called
people.dfc[peoplesearchform]
File Name
Syntax
BrowsePeopleEvent(REF person: BrowsePeopleInstRec)
Parameters
person - record which contains people details
Returns
Nothing
Side Effects
None
Description
This event will control viewing for the details of the selected record from the search dialog box. You can also print the details.
Dialog Forms Called
None
File Name
Syntax
BrowseQuickContactEvent(REF quickcontact: QuickContactRec)
Parameters
None
Returns
Nothing
Side Effects
None
Description
This event is the event handler for browsing quick contact information.
Dialog Forms Called
None
File Name
Syntax
BrowseQuickContacts(REF quickcontact: QuickContactRec)
Parameters
quickcontact - quick contact record used for selected contact
Returns
Nothing
Side Effects
None
Description
This procedure will begin the browsequickcontacts event with the quick contacts dialog box.
Dialog Forms Called
people.dfc[quickcontactform]
File Name
Syntax
ClearEntryFields(VAL w: WINDOW)
Parameters
w - parent window handle
Returns
Nothing
Side Effects
None
Description
This procedure will clear all entry boxes.
Dialog Forms Called
None
File Name
Syntax
CollectPeopleValues(REF viewpeople: BrowsePeopleListRec, VAL w: WINDOW, REF peopledata: PeopleSearchRec, REF userdata: SearchUserRec,REF miscdata: SearchMiscRec): BOOLEAN
Parameters
viewpeople - record which contains people to be displayed in the MCLB
w - parent window handle
peopledata - people data used for search criteria
userdata - user data used for search criteria
miscdata - additional person data used for search criteria
Returns
TRUE - at least one of the fields has data,
FALSE - if none of the fields has data
Side Effects
None
Description
This function will collect values of all entry boxes depending on the current search form being used. These values are read into the BrowsePeopleListRec to be used in creating the search string. If none of the entry fields has data, the Boolean is returned false, and all people are listed.
Dialog Forms Called
None
File Name
Syntax
CompletePersonPartial(VAL w: WINDOW, REF oldAK: STRING, REF ContinueEdit: BOOLEAN, VAL srchType: INTEGER, VAL field: STRING, VAL nextField: STRING): INTEGER
Parameters
w - parent window handle
ContinueEdit - TRUE if user wants to continue editing the entryfield,
FALSE if the user does not want to continue editing the entryfield
srchType - search choice
field - name of field last exited
nextField - name of next field
Returns
Integer
Side Effects
Entry box filled in with last name, middle name, and initial if person record found
Description
When the user enters the first few letters of a person's last name, the letters are used to find a match. If there is only one, the last name, middle name, and first name are filled in. If there are multiple, a list appears from which to choose.
Dialog Forms Called
None
File Name
Syntax
ContactPeople
Parameters
None
Returns
Nothing
Side Effects
None
Description
This procedure allows users to search for people by contact information.
Dialog Forms Called
people.dfc[peoplesearchcontacts]
File Name
Syntax
CreateSearchSelectString(REF finalselect: STRING, REF peopledata: PeopleSearchRec, REF userdata: SearchUserRec, REF miscdata: SearchMiscRec, REF viewpeople: BrowsePeopleListRec)
Parameters
finalselect - final select string (combination of other four parameters)
peopledata - data from boxes on General tab of People dialog box
userdata - data from boxes on User tab of People dialog box
miscdata - data from boxes on other tabs of People dialog boxes
viewpeople - record which contains people to be displayed
in the MCLB
Returns
Nothing
Side Effects
None
Description
This procedure will create select strings for each portion of the Find dialog box - people, users, contacts, locations, organizations, and groups. Use SQLCreateString to create the select statement for people and user. Location, Organization, and group will need to be done manually because they are a join of multiple tables. Then get the matching people IDs to use for selecting records.
Dialog Forms Called
None
File Name
Syntax
DisplayAllPeople(REF displayselect: STRING, REF viewpeople: BrowsePeopleListRec, VAL w: WINDOW,REF peotype: STRING)
Parameters
displayselect - contains the select statement for selecting all
people records
viewpeopledata - record which contains people to be displayed
in the MCLB
w - parent window handle
peotype - person selector type
Returns
Nothing
Side Effects
None
Description
This procedure will display all people currently in the database.
Dialog Forms Called
None
File Name
Syntax
DisplayOverallCap(VAL w: WINDOW, REF person: BrowsePeopleInstRec)
Parameters
w - parent window handle
person - record with person details for entry fields
Returns
Nothing
Side Effects
None
Description
This procedure will display the overall capabilities for the user and their user and group rights.
Dialog Forms Called
None
File Name
Syntax
DisplayPersonName( REF person: BrowsePeopleListRec )
Parameters
person - record which contains people to be displayed
in the MCLB
Returns
Nothing
Side Effects
None
Description
Function for formatting last name, first name, and middle initial to be sent back to the calling dialog box.
Dialog Forms Called
None
File Name
Syntax
DisplayUserCap(VAL w: WINDOW, REF person: BrowsePeopleInstRec)
Parameters
w - parent window handle
person - record with person details for entry fields
Returns
Nothing
Side Effects
None
Description
This procedure will fill dispaly capabilities for the selected user.
Dialog Forms Called
None
File Name
Syntax
EnableDiagRight( VAL diagType: INTEGER, VAL rightsMask: INTEGER )
Parameters
diagType - diagnostic type
rightsMask - knowledge rights mask
Returns
TRUE if there is at least one diagnostic right enabled,
FALSE if no diagnostic rights are enabled
Side Effects
None
Description
This procedure will enable diagnostic rights depending on the diagnostic type.
Dialog Forms Called
None
File Name
Syntax
FillContacts(VAL w: WINDOW, REF person: BrowsePeopleInstRec)
Parameters
w - parent window handle
person - record with person details for entry fields
Returns
Nothing
Side Effects
None
Description
This procedure will fill the MCLB's on the contacts tab of the people dialog box.
Dialog Forms Called
None
File Name
Syntax
FillGeneral(VAL w: WINDOW, REF person: BrowsePeopleInstRec)
Parameters
w - parent window handle
person - record with details for entry fields
Returns
Nothing
Side Effects
None
Description
This procedure will fill the MCLB's on the General tab of the People dialog box.
Dialog Forms Called
None
File Name
Syntax
FillListMCLB
Parameters
None
Returns
Nothing
Side Effects
None
Description
This procedure will fill the MCLB's on the General tab of the People dialog box.
Dialog Forms Called
None
File Name
Syntax
FillQuickContacts
Parameters
None
Returns
Nothing
Side Effects
None
Description
This procedure will fill the MCLB's on the Quick Contacts form.
Dialog Forms Called
None
File Name
Syntax
FillUsers(VAL w: WINDOW, REF person: BrowsePeopleInstRec)
Parameters
w - parent window handle
person - record with person details for entry boxes
Returns
Nothing
Side Effects
None
Description
This procedure will fill the MCLB on the User tab of the People dialog box.
Dialog Forms Called
None
File Name
Syntax
FillWebPages(VAL w: WINDOW, REF person: BrowsePeopleInstRec)
Parameters
w - parent window handle
person - record with person details for entry fields
Returns
Nothing
Side Effects
None
Description
This procedure will fill the web information in the People dialog box.
Dialog Forms Called
None
File Name
Syntax
GetContactConfig(REF person: BrowsePeopleInstRec)
Parameters
person - record with person details for entry boxes
Returns
Nothing
Side Effects
None
Description
This procedure will fill the configuration option for contacts.
Dialog Forms Called
None
File Name
Syntax
GetContactConfig(REF person: BrowsePeopleInstRec)
Parameters
person - record with person details for entry boxes
Returns
Nothing
Side Effects
None
Description
This procedure will fill the configuration option for contacts.
Dialog Forms Called
None
File Name
Syntax
GetRightsFromMask(REF mask: INTEGER, REF currights: LIST OF STRING)
Parameters
mask - current security mask to evaluate
currights - list of current rights
Returns
Nothing
Side Effects
None
Description
Uses the security mask to evaluate which rights the user currently has.
Dialog Forms Called
None
File Name
Syntax
PeopleFindEvent(REF viewpeople: BrowsePeopleListRec)
Parameters
viewpeople - record which contains people to be displayed
in the MCLB
Returns
Nothing
Side Effects
None
Description
This event will control searching by the entered search criteria for a matching people record and displaying that record in the MCLB. It will also return selected records to the parent window if not mainwindow. This event will also invoke the BrowseNBEvent for viewing the details of a selected people record using the People dialog box.
Dialog Forms Called
None
File Name
Syntax
PeopleSelectEvent(REF selectpeople: LIST OF BrowsePeopleListRec)
Parameters
selectpeople - record which contains people to be displayed in
the MCLB
Returns
Nothing
Side Effects
None
Description
This event is used when completepartialname finds a list of matching people. Then the selected person is returned to the calling dialog box.
Dialog Forms Called
None
File Name
Syntax
None
Parameters
Returns
None
Side Effects
None
Description
Creates select string for finding matching people records based on contact_id.
Dialog Forms Called
None
File Name
Syntax
None
Parameters
Returns
None
Side Effects
None
Description
Creates select string for finding matching people records.
Dialog Forms Called
None
File Name
Syntax
None
Parameters
Returns
None
Side Effects
None
Description
When there is more than one match, shows list to have user select the correct one.
Dialog Forms Called
people.dfc[peoplelist]
File Name
Syntax
None
Parameters
Returns
None
Side Effects
None
Description
Creates select string for finding matching people records based on user_id.
Dialog Forms Called
None
File Name
Syntax
PrintPeopleSelect(VAL wHdl: WINDOW, VAL pwhdl: WINDOW, VAL title: STRING, VAL formtype: STRING, VAL PrintInfo: LIST OF ScreenPrintRec)
Parameters
whdl - current window handle
pwhdl - parent window handle
title - title header for printout
formtype - main or quick contact
PrintInfo - People dialog box information to be printed
Returns
Nothing
Side Effects
None
Description
This procedure will print the selected person information.
Dialog Forms Called
c_prnt.dfc[printchoice]
people.dfc[peoplenotebook]
people.dfc[quickcontactform]
File Name
Syntax
QuickContact( val whdl: window )
Parameters
whdl - parent window handle
Returns
Nothing
Side Effects
None
Description
The message SELECTED_PERSON_MSG will be sent to the parent window when the first paramater of the message is a BrowsePeopleListRec record. Call this procedure to pop a work with contacts window and select a contact. The function will send a message to the window handle passed in.
Dialog Forms Called
people.dfc[peoplesearchcontacts]
File Name
Syntax
SendManyPeopleBackToParent(REF parentw: WINDOW, REF selectedpeoList: LIST OF BrowsePeopleListRec)
Parameters
parentw - parent window handle
selectedpeoList - list of selected people
Returns
Nothing
Side Effects
None
Description
When this dialog box event is invoked from another dialog box or application, the selected value in the MCLB will be returned to parentwindow.
Dialog Forms Called
None
File Name
Syntax
SendPersonBackToParent(REF parentw: WINDOW, REF selectedpeo: BrowsePeopleListRec)
Parameters
parentw - parent window handle
selectedpeo - record of selected person
Returns
Nothing
Side Effects
None
Description
When this dialog box event is invoked from another dialog box or application, the selected value in the MCLB is returned to parentwindow.
Dialog Forms Called
None
File Name
Syntax
SetButtons
Parameters
Nothing
Returns
Nothing
Side Effects
None
Description
This procedure sets the correct buttons for viewing or selecting. The add, view, copy, delete buttons are hidden. The edit button becomes the view.
Dialog Forms Called
people.dfc[peoplesearchform]
people.dfc[peoplesearchuser]
people.dfc[multi_roster_form]
people.dfc[non_multi_roster_form]
people.dfc[peoplesearchonly]
people.dfc[peoplesearchcontacts]
File Name
Syntax
SetEnabled(VAL w: WINDOW)
Parameters
w - parent window handle
Returns
Nothing
Side Effects
None
Description
This procedure will set all controls to read only since it will only be used for viewing.
Dialog Forms Called
None
File Name
Syntax
SetQuickEnabled(VAL w: WINDOW)
Parameters
None
Returns
Nothing
Side Effects
None
Description
This procedure will diable the quick contact fields.
Dialog Forms Called
None
File Name
Syntax
SetUserEnabled(VAL w: WINDOW)
Parameters
w - parent window handle
Returns
Nothing
Side Effects
None
Description
This procedure will set the boxes on the user tab disabled if the user does not have user administration rights.
Dialog Forms Called
None
File Name
Syntax
SetViewButtons(VAL w: WINDOW)
Parameters
w - parent window handle
Returns
Nothing
Side Effects
None
Description
This procedure will set the correct buttons for viewing or selecting. The add, view, copy, delete buttons are hidden. The edit button becomes the view.
Dialog Forms Called
None
File Name
Syntax
ViewLocations(VAL w: WINDOW)
Parameters
w - parent window handle
Returns
Nothing
Side Effects
None
Description
This procedure will set up the necessary information in the treerec for viewing a location.
Dialog Forms Called
None
File Name
Syntax
ViewOrganizations(VAL w: WINDOW)
Parameters
w - parent window handle
Returns
Nothing
Side Effects
None
Description
This procedure will set up the necessary information in the treerec for viewing an organization.
Dialog Forms Called
None
File Name
Syntax
ViewSupportedOrg(VAL w: WINDOW)
Parameters
w - parent window handle
Returns
Nothing
Side Effects
None
Description
This procedure will set up the necessary information in the treerec for viewing an organization.
Dialog Forms Called
None