PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • Overview
  • The variables of Palm structure
  • Palm structure used by the Notepad
  • Palm structure used for the task list
  • Palm structure used for the address book
  • Palm structure used for the calendar
  • Which functions use the Palm structure?
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
Warning
From version 16, this feature is no longer available.
Overview
The Palm structure is a preset structure of WLanguage (no declaration is required). This structure is used to:
  • create a Palm record,
  • retrieve the content of a Palm record.
Note: The variables of the Palm structure differ according to the database used: Notepad, Task List, Address Book and Calendar.
The variables of Palm structure

Palm structure used by the Notepad

The structure contains the following members:
palm.CategoryCharacter string
Category of record (up to 16 characters).
Variable in read/write mode.

When adding a record, if this variable is equal to:
  • an existing category, the message added is associated with this category.
  • a non-existing category, this category is created.
  • an empty category (empty string): the message is added to the "Not classified" category.
palmMemo.DataCharacter string.
Data of record found in the Palm "Notepad" database (message subject and message body in binary format).
Variable in read/write mode.
palm.PositionInteger.
Position of current record.
The variable in read-only mode.

Palm structure used for the task list

The structure contains the following members:
palm.CategoryCharacter string
Category of record (up to 16 characters).
Variable in read/write mode.
When adding a record, if this variable is equal to:
  • an existing category, the message added is associated with this category.
  • a non-existing category, this category is created.
  • an empty category (empty string): the message is added to the "Not classified" category.
palmMemo.DataCharacter string.
Data for the record found in the Palm "Task List" database (in binary format).
Variable in read/write mode.
palm.PositionInteger.
Position of current record.
The variable in read-only mode.
palmTask.CompletedBoolean.
  • True if the task is completed,
  • False otherwise.
Variable in read/write mode.
palmTask.DeadLineCharacter string in "YYYYMMDD" format or Date variable.
Deadline of the task (date before which the task must be done).
palmTask.DescriptionCharacter string.
Caption of the task to perform.
Variable in read/write mode.
palmTask.NotesCharacter string (up to 2047 characters).
Comments about the task to perform.
Variable in read/write mode.
palmTask.PriorityInteger included between 1 and 5.
Priority of the task to perform (1 = Maximum priority)

Palm structure used for the address book

The structure contains the following members:
palmAddress.AddressCharacter string (up to 255 characters).
Address of the contact.
Variable in read/write.
palmAddress.ZipCodeCharacter string (up to 63 characters).
Zip code for the address of the contact.
Variable in read/write.
palmAddress.ContactArray of character strings (array of 5 elements maximum, each element can contain up to 63 characters)
Number (or email address) used to contact the person. This number must correspond to the type of contact specified in palmAddress.ContactType.
Variable in read/write.
palmAddress.DefineArray of character strings (array of 4 elements maximum, each element can contain up to 255 characters)
Additional information about the contact, his address, ...
Variable in read/write.
palmAddress.StateCharacter string (up to 255 characters).
State corresponding to the address of the contact.
Variable in read/write.
palmAddress.TitleCharacter string (up to 255 characters).
Position of the contact in the company (title, ...).
Variable in read/write.
palmAddress.NameCharacter string (up to 255 characters).
Name of the person.
Variable in read/write.
palmAddress.NotesCharacter string (up to 2047 characters).
Note attached to the contact and to his address.
Variable in read/write.
palmAddress.MainContactNumInteger (from 1 to 5)
Number of the element to display as the main contact to reach the person. This number corresponds to the number of one of the elements found in the palmAddress.ContactType and palmAddress.Contact arrays.
The information regarding the main contact will be the only information displayed when the address book is in list format.
Variable in read/write mode.

Example: palmAddress.MainContactNum = 2 if the main way to contact a person is his phone number at the office and if this number is the second element in the palmAddress.ContactType and palmAddress.Contact arrays.
PalmAddress.CountryCharacter string (up to 255 characters).
Country corresponding to the address of the person.
Variable in read/write.
palmAddress.FirstNameCharacter string (up to 255 characters).
First name of the person.
Variable in read/write.
PalmAddress.CompanyCharacter string (up to 255 characters).
Name of the company where the person works.
Variable in read/write.
palmAddress.ContactTypeArray of character strings (array containing up to 5 elements)
Defines the type of contact found in the corresponding palmAddress.Contact variable. This parameter corresponds to one of the following constants:
palmOtherContactOther way of contact not found in the list below.
palmPagerContactPager number
palmWorkContactWork phone number (default value of the palmAddress.ContactType variable)
palmHomeContactHome phone number
palmEmailContactEmail address
palmFaxContactFax number
palmCellContactNumber of mobile phone
palmMainContactMain number for contacting the person.
palmAddress.CityCharacter string (up to 255 characters).
City corresponding to the address of the contact.
Variable in read/write.
palm.CategoryCharacter string
Category of record (up to 16 characters).
Variable in read/write mode.
When adding a record, if this variable is equal to:
  • an existing category, the message added is associated with this category.
  • a non-existing category, this category is created.
  • an empty category (empty string): the message is added to the "Not classified" category.
palmMemo.DataCharacter string.
Data for the record found in the Palm "Address Book" database (in binary format).
Variable in read/write mode.
palm.PositionInteger.
Position of current record.
The variable in read-only mode.

Palm structure used for the calendar

The structure contains the following members:
PalmOrganizer.AlarmTypeUnit used to configure the alarm. This unit corresponds to one of the following constants:
palmAlarmHourAlarm expressed in number of hours. Example: alarm XX hours before the beginning of the organizer task.
palmAlarmDayAlarm expressed in number of days. Example: alarm XX days before the beginning of the organizer task.
palmAlarmMinuteAlarm expressed in number of minutes. Example: alarm XX minutes before the beginning of the organizer task.
palmNoneNo alarm

The palmOrganizer.AlarmValue variable will be expressed in this unit .
Variable in read/write.
palmOrganizer.AlarmValueInteger.
Value of the alarm. Corresponds to the number of units required to start the alarm. For example, to trigger the alarm 5 minutes before the beginning of the task in the calendar, enter the following code:
palmOrganizer.AlarmValue = 5
PalmOrganizer.AlarmUnit = PalmAlarmMinute
Variable in read/write mode.
palmOrganizer.DateCharacter string in YYYYMMDD format or Date variable.
Mandatory information.
Date of the task saved in the calendar. If the date is not specified, the task will be automatically assigned to today's date.
Variable in read/write mode.
palmOrganizer.DescriptionCharacter string (up to 511 characters).
Mandatory information.
Description of the task saved in the calendar.
Variable in read/write mode.
palmOrganizer.StartTimeCharacter string in HHMMSSCCC format
Start time of the task saved in the calendar.
Only the hours and the minutes are taken into account (HHMM). If a task has no time, PalmOrganizer.StartTime and PalmOrganizer.EndTime are set to 00:00.
Variable in read/write mode.
palmOrganizer.EndTimeCharacter string in HHMMSSCCC format
End time of the task saved in the calendar.
Only the hours and the minutes are taken into account (HHMM). If a task has no time, PalmOrganizer.StartTime and PalmOrganizer.EndTime are set to 00:00.
Variable in read/write mode.
palmOrganizer.NotesCharacter string (up to 511 characters).
Additional notes about the task saved in the calendar.
Variable in read/write mode.
palmOrganizer.EndDateRepetitionCharacter string in YYYYMMDD format or Date variable. Mandatory information.
End time of the recurring task saved in the calendar. If this date is not specified while a repetition was requested, the repetition will never end.
Variable in read/write mode.
palmOrganizer.ExceptionsRepetitionCharacter string in the format "YYYYMMDD+CR+YYYYMMDD+CR+..."
Days that must be omitted for the recurring task saved in the calendar.
Variable in read/write mode.
palmOrganizer.IntervalRepetitionInteger included between 0 and 99.
Repetition interval. This interval depends on the type of repetition (palmAgenda.RepetitionType variable)
Variable in read/write mode.
palmOrganizer.DaysRepetitionArray of booleans (up to 7 elements)
Day of the week affected by the repetition. The first element of the array corresponds to Sunday.
This variable is taken into account only if palmOrganizer.RepetitionType = palmWeeklyRepetition. To repeat the task on the selected day, the corresponding array element must be initialized to True.
Example: To repeat a task every Monday, you must use: palmOrganizer.DaysRepetition[2]=True
Variable in read/write mode.
palmOrganizer.WeekNumRepetitionInteger included between 1 and 5.
Number of the recurring week (in the month). This variable is taken into account only if palmOrganizer.RepetitionType = palmMonthlyRepetitionByDay.
Read-only variable EXCEPT when the week number corresponds to the 4th or 5th week.
5th week = week starting at the end of the month.
palmOrganizer.RepetitionTypeInteger constant
Type of the repetition to perform. Corresponds to one of the following constants:
palmNoneNo repetition
palmYearlyRepetitionTask performed every XX years
palmWeeklyRepetitionTask performed every XX weeks, on Monday, Tuesday...
palmMonthlyRepetitionByDateTask performed every XX of the month (where XX represents the day). XX is defined according to the start date of the task. For example, task starting on 08/19/02 and repeated every month on the 19th.
palmMonthlyRepetitionByDayTask performed every XX day of each month. The day of the week and its position in the month are defined according to the start date of the task. For example, task starting on Monday 08/19/02 and repeated every 3rd Monday of each month or task starting on Thursday 08/22/02 and repeated every 4th Thursday of each month
palmDailyRepetitionTask performed every XX days
PalmOrganizer.NoTimeBoolean
True if no precise schedule is defined for the task. This variable has priority over the start and end task times.
If a task has no time, PalmOrganizer.StartTime and PalmOrganizer.EndTime are set to 00:00.
palmMemo.DataCharacter string.
Data of the record found in the Palm "Organize" database (in binary format).
Variable in read/write mode.
palm.PositionInteger.
Position of current record.
The variable in read-only mode.
Which functions use the Palm structure?
The following functions use the Palm structure:
PalmAddAdds a record to one of the Palm Pilot databases
PalmReadReturns an information about the current record: content of the record, its category or its position
PalmReadLastPositions on the last record of the specified access and reads this record
PalmReadPreviousPositions on the previous record of the specified access and reads this record
PalmReadFirstPositions on the first record of the specified access and reads this record
PalmReadNextPositions on the next record of the specified access and reads this record
PalmModifyModifies the current record
Minimum required version
  • Version 9
Comments
Click [Add] to post a comment