source: branches/mediafolder/prog_tutorial/old/wpmethoddesc.inc

Last change on this file was 2, checked in by stevenhl, 8 years ago

Import sources from cwmm-full.zip dated 2005-03-21
File size: 28.5 KB
Line 
1.******************************************************
2
3:h2 res=450
4width=30%
5.wpClose
6:link reftype=hd res=451
7auto dependent group=2.
8:p.
9:link reftype=hd res=451.Syntax:elink.
10.br
11:link reftype=hd res=453 dependent.Returns:elink.
12.*.br
13.*:link reftype=hd res=314 dependent.Remarks:elink.
14.*.br
15.*:link reftype=hd res=315.Usage:elink.
16.*.br
17.*:link reftype=hd res=416 dependent.Example:elink.
18
19:h2 res=451
20x=30%
21width=70%
22hide
23group=2
24.wpClose - Syntax
25:xmp.
26/* Close all open views of an object */
27
28theObject /* WPS-object */
29:p.
30rc=MFldrCallWPSFunc("wpClose", theObject);
31:exmp.
32
33
34:h2 res=453
35x=30%
36width=70% height=35%
37group=3
38hide
39.wpClose - Return value
40:p.
41:hp2.rc:ehp2. numeric
42:p.
43The return value is 0 if an error occured.
44
45.******************************************************
46
47:h2 res=460
48width=30%
49.wpHide
50:link reftype=hd res=461
51auto dependent group=2.
52:p.
53:link reftype=hd res=461.Syntax:elink.
54.br
55:link reftype=hd res=463 dependent.Returns:elink.
56.*.br
57.*:link reftype=hd res=314 dependent.Remarks:elink.
58.*.br
59.*:link reftype=hd res=315.Usage:elink.
60.*.br
61.*:link reftype=hd res=416 dependent.Example:elink.
62
63:h2 res=461
64x=30%
65width=70%
66hide
67group=2
68.wpHide - Syntax
69:xmp.
70/* Hide all open views of an object */
71
72theObject /* WPS-object */
73:p.
74rc=MFldrCallWPSFunc("wpHide", theObject);
75:exmp.
76
77
78:h2 res=463
79x=30%
80width=70% height=35%
81group=3
82hide
83.wpHide - Return value
84:p.
85:hp2.rc:ehp2. numeric
86:p.
87The return value is 0 if an error occured.
88
89.******************************************************
90
91:h2 res=470
92width=30%
93.wpIsDeleteable
94:link reftype=hd res=471
95auto dependent group=2.
96:p.
97:link reftype=hd res=471.Syntax:elink.
98.br
99:link reftype=hd res=473 dependent.Returns:elink.
100.*.br
101.*:link reftype=hd res=314 dependent.Remarks:elink.
102.*.br
103.*:link reftype=hd res=315.Usage:elink.
104.*.br
105.*:link reftype=hd res=416 dependent.Example:elink.
106
107:h2 res=471
108x=30%
109width=70%
110hide
111group=2
112.wpIsDeleteable - Syntax
113:xmp.
114/* Check if an object is deleteable */
115
116theObject /* The WPS-object to be checked */
117:p.
118rc=MFldrCallWPSFunc("wpIsDeleteable", theObject);
119:exmp.
120
121
122:h2 res=473
123x=30%
124width=70% height=35%
125group=3
126hide
127.wpIsDeleteable - Return value
128:p.
129:hp2.rc:ehp2. numeric
130:p.
131The return value is 0 if not deletable.
132
133.******************************************************
134
135:h2 res=480
136width=30%
137.wpQueryAttr
138:link reftype=hd res=481
139auto dependent group=2.
140:p.
141:link reftype=hd res=481.Syntax:elink.
142.br
143:link reftype=hd res=483 dependent.Returns:elink.
144.*.br
145.*:link reftype=hd res=314 dependent.Remarks:elink.
146.*.br
147.*:link reftype=hd res=315.Usage:elink.
148.*.br
149.*:link reftype=hd res=416 dependent.Example:elink.
150
151:h2 res=481
152x=30%
153width=70%
154hide
155group=2
156.wpQueryAttr - Syntax
157:xmp.
158/* Query the file attributes of an object */
159
160theObject /* The WPS-object to be checked
161 Must be of class WPFileSystem */
162:p.
163rc=MFldrCallWPSFunc("wpQueryAttr", theObject);
164:exmp.
165
166
167:h2 res=483
168x=30%
169width=70% height=35%
170group=3
171hide
172.wpQueryAttr - Return value
173:p.
174:hp2.rc:ehp2. numeric
175:p.
176The return value is a bit mask of the file attributes.
177
178
179.******************************************************
180
181:h2 res=490
182width=30%
183.wpQueryConcurrentView
184:link reftype=hd res=491
185auto dependent group=2.
186:p.
187:link reftype=hd res=491.Syntax:elink.
188.br
189:link reftype=hd res=493 dependent.Returns:elink.
190.*.br
191.*:link reftype=hd res=314 dependent.Remarks:elink.
192.*.br
193.*:link reftype=hd res=315.Usage:elink.
194.*.br
195.*:link reftype=hd res=416 dependent.Example:elink.
196
197:h2 res=491
198x=30%
199width=70%
200hide
201group=2
202.wpQueryConcurrentView - Syntax
203:xmp.
204/* Query the concurrent view behavior of an object */
205
206theObject /* The WPS-object to be checked */
207:p.
208ulView=MFldrCallWPSFunc("wpQueryConcurrentView",
209 theObject);
210:exmp.
211
212
213:h2 res=493
214x=30%
215width=70% height=55%
216group=3
217hide
218.wpQueryConcurrentView - Return value
219:p.
220:hp2.ulView:ehp2. numeric
221:p.
222The return value is one of the following:
223
224:ul.
225:li.CCVIEW_DEFAULT: 0
226.br
227Concurrent view is set to system default.
228:li.CCVIEW_ON: 1
229.br
230Concurrent view is off.
231:li.CCVIEW_OFF: 2
232.br
233Concurrent view is off.
234:eul.
235
236
237
238.******************************************************
239
240:h2 res=500
241width=30%
242.wpQueryConfirmations
243:link reftype=hd res=501
244auto dependent group=2.
245:p.
246:link reftype=hd res=501.Syntax:elink.
247.br
248:link reftype=hd res=503 dependent.Returns:elink.
249.*.br
250.*:link reftype=hd res=314 dependent.Remarks:elink.
251.*.br
252.*:link reftype=hd res=315.Usage:elink.
253.*.br
254.*:link reftype=hd res=416 dependent.Example:elink.
255
256:h2 res=501
257x=30%
258width=70%
259hide
260group=2
261.wpQueryConfirmations - Syntax
262:xmp.
263/* Query which confirmations are set for this
264 object */
265
266theObject /* The WPS-object on which the method is invoked */
267:p.
268ulFlag=MFldrCallWPSFunc("wpQueryConfirmations", theObject);
269:exmp.
270
271
272:h2 res=503
273x=30%
274width=70% height=55%
275group=3
276hide
277.wpQueryConfirmations - Return value
278:p.
279:hp2.ulFlag:ehp2. numeric
280:p.
281The return value is one of the following.
282:ul.
283:li.0
284.br
285No confirmation set.
286:li.CONFIRM_DELETE 0x0001
287.br
288Prompt for all objects.
289:li.CONFIRM_DELETEFOLDER 0x0002
290.br
291Prompt for folders only.
292:li.CONFIRM_RENAMEFILESWITHEXT 0x0004
293.br
294Prompt when renaming files with extension.
295:li.CONFIRM_KEEPASSOC 0x0008
296.br
297Prompt if file to be renamed has an association depending on the extension.
298:li.CONFIRM_ACTION 0x0010
299.br
300Prompt when moving, copying or creating shadows.
301:li.CONFIRM_PROGRESS 0x0020
302.br
303Display a dialog box when performing a copy, move etc.
304:li.CONFIRM_ALLOWFORCEDELETE 0x0040
305.br
306Allow forced delete. Must be set when CONFIRM_FORCEDELETE is set.
307:li.CONFIRM_FORCEDELETE 0x0080
308.br
309Prompt for confirmation of forced deletion.
310:eul.
311
312The values are returned as decimal numbers.
313
314
315.******************************************************
316
317:h2 res=510
318width=30%
319.wpQueryContent
320:link reftype=hd res=511
321auto dependent group=2.
322:p.
323:link reftype=hd res=511.Syntax:elink.
324.br
325:link reftype=hd res=513 dependent.Returns:elink.
326.br
327:link reftype=hd res=514 dependent.Remarks:elink.
328.*.br
329.*:link reftype=hd res=315.Usage:elink.
330.*.br
331.*:link reftype=hd res=416 dependent.Example:elink.
332
333:h2 res=511
334x=30%
335width=70%
336hide
337group=2
338.wpQueryContent - Syntax
339:xmp.
340/* Query the contents of a folder */
341
342theFolder /* The folder to be checked */
343theObject /* Previous object or NULL */
344option /* option, which object to query
345 (QC_FIRST, QC_NEXT, QC_LAST)
346:p.
347object=MFldrCallWPSFunc("wpQueryContent",
348 theObject, option);
349:exmp.
350
351
352:h2 res=513
353x=30%
354width=70% height=55%
355group=3
356hide
357.wpQueryContent - Return value
358:p.
359:hp2.object:ehp2. numeric
360:p.
361Pointer to the requested object.
362
363
364:h2 res=514
365x=30%
366width=70%
367group=2
368hide
369.wpQueryContent - Remarks
370:p.
371Specify QC_FIRST (0) to get the first object in the folder, QC_LAST (2) for the last. When
372using QC_NEXT (1) then :hp2.theObject:ehp2. points to the previous object otherwise this
373parameter is ignored.
374:p.
375The order of the objects returned is the order in the internal list of the folder. It's no
376necessarily the order in which the objects appear in the container.
377
378
379
380.******************************************************
381
382:h2 res=520
383width=30%
384.wpQueryDefaultView
385:link reftype=hd res=521
386auto dependent group=2.
387:p.
388:link reftype=hd res=521.Syntax:elink.
389.br
390:link reftype=hd res=523 dependent.Returns:elink.
391.*.br
392.*:link reftype=hd res=314 dependent.Remarks:elink.
393.*.br
394.*:link reftype=hd res=315.Usage:elink.
395.*.br
396.*:link reftype=hd res=416 dependent.Example:elink.
397
398:h2 res=521
399x=30%
400width=70%
401hide
402group=2
403.wpQueryDefaultView - Syntax
404:xmp.
405/* Query the default view of an object */
406
407theObject /* The WPS-object to be checked */
408:p.
409ulView=MFldrCallWPSFunc("wpQueryDefaultView",
410 theObject);
411:exmp.
412
413
414:h2 res=523
415x=30%
416width=70% height=55%
417group=3
418hide
419.wpQueryDefaultView - Return value
420:p.
421:hp2.ulView:ehp2. numeric
422:p.
423The return value is one of the following:
424
425:ul.
426:li.OPEN_CONTENTS: 1
427.br
428Open in contents view (icon).
429:li.OPEN_DEFAULT: 0
430.br
431Same as doubleclick.
432:li.OPEN_DETAILS: 102
433.br
434Details view.
435:li.OPEN_HELP: 3
436.br
437Display the help panel.
438:li.OPEN_RUNNING: 4
439.br
440Execute the object.
441:li.OPEN_SETTINGS: 2
442.br
443Open the settings of the object.
444:li.OPEN_TREE: 101
445.br
446Open the tree view.
447:li.OPEN_UNKNOWN: -1
448.br
449Unknown view.
450:li.OPEN_USER: 0x6500 or higher
451.br
452A user view introduced by a subclass.
453:eul.
454
455
456
457.******************************************************
458
459:h2 res=530
460width=30%
461.wpQueryDisk
462:link reftype=hd res=531
463auto dependent group=2.
464:p.
465:link reftype=hd res=531.Syntax:elink.
466.br
467:link reftype=hd res=533 dependent.Returns:elink.
468.*.br
469.*:link reftype=hd res=314 dependent.Remarks:elink.
470.*.br
471.*:link reftype=hd res=315.Usage:elink.
472.*.br
473.*:link reftype=hd res=416 dependent.Example:elink.
474
475:h2 res=531
476x=30%
477width=70%
478hide
479group=2
480.wpQueryDisk - Syntax
481:xmp.
482/* Query the disk object a file system
483 object is located on */
484
485theObject /* The file system object to be checked */
486:p.
487Disk=MFldrCallWPSFunc("wpQueryDisk",
488 theObject);
489:exmp.
490
491
492:h2 res=533
493x=30%
494width=70% height=55%
495group=3
496hide
497.wpQueryDisk - Return value
498:p.
499:hp2.Disk:ehp2. numeric
500:p.
501The return value is a pointer to the disk object of the drive the file system object is
502located on.
503
504.******************************************************
505
506:h2 res=540
507width=30%
508.wpQueryEASize
509:link reftype=hd res=541
510auto dependent group=2.
511:p.
512:link reftype=hd res=541.Syntax:elink.
513.br
514:link reftype=hd res=543 dependent.Returns:elink.
515.*.br
516.*:link reftype=hd res=314 dependent.Remarks:elink.
517.*.br
518.*:link reftype=hd res=315.Usage:elink.
519.*.br
520.*:link reftype=hd res=416 dependent.Example:elink.
521
522:h2 res=541
523x=30%
524width=70%
525hide
526group=2
527.wpQueryEASize - Syntax
528:xmp.
529/* Query the size of the EAs of a file system
530 object */
531
532theObject /* The file system object */
533:p.
534eaSize=MFldrCallWPSFunc("wpQueryEASize",
535 theObject);
536:exmp.
537
538
539:h2 res=543
540x=30%
541width=70% height=55%
542group=3
543hide
544.wpQueryEASize - Return value
545:p.
546:hp2.eaSize:ehp2. numeric
547:p.
548The return value is the size of the extended attributes of a file.
549
550
551.******************************************************
552
553:h2 res=550
554width=30%
555.wpQueryFileSize
556:link reftype=hd res=551
557auto dependent group=2.
558:p.
559:link reftype=hd res=551.Syntax:elink.
560.br
561:link reftype=hd res=553 dependent.Returns:elink.
562.*.br
563.*:link reftype=hd res=314 dependent.Remarks:elink.
564.*.br
565.*:link reftype=hd res=315.Usage:elink.
566.*.br
567.*:link reftype=hd res=416 dependent.Example:elink.
568
569:h2 res=551
570x=30%
571width=70%
572hide
573group=2
574.wpQueryFileSize - Syntax
575:xmp.
576/* Query the size file */
577
578theObject /* The file system object */
579:p.
580size=MFldrCallWPSFunc("wpQueryFileSize",
581 theObject);
582:exmp.
583
584
585:h2 res=553
586x=30%
587width=70% height=55%
588group=3
589hide
590.wpQueryFileSize - Return value
591:p.
592:hp2.size:ehp2. numeric
593:p.
594The return value is the size of the file.
595
596.******************************************************
597
598:h2 res=560
599width=30%
600.wpQueryFldrFlags
601:link reftype=hd res=561
602auto dependent group=2.
603:p.
604:link reftype=hd res=561.Syntax:elink.
605.br
606:link reftype=hd res=563 dependent.Returns:elink.
607.*.br
608.*:link reftype=hd res=314 dependent.Remarks:elink.
609.*.br
610.*:link reftype=hd res=315.Usage:elink.
611.*.br
612.*:link reftype=hd res=416 dependent.Example:elink.
613
614:h2 res=561
615x=30%
616width=70%
617hide
618group=2
619.wpQueryFldrFlags - Syntax
620:xmp.
621/* Query the flags of a folder */
622
623theFolder /* The folder object */
624:p.
625flags=MFldrCallWPSFunc("wpQueryFldrFlags",
626 theFolder);
627:exmp.
628
629
630:h2 res=563
631x=30%
632width=70% height=55%
633group=3
634hide
635.wpQueryFldrFlags - Return value
636:p.
637:hp2.flags:ehp2. numeric
638:p.
639The return value is a bitmask of the following.
640
641:ul.
642:li.FOI_POPULATEDWITHALL 0x0001
643.br
644The folder is populated with all objects.
645:li.FOI_POPULATEDWITHFOLDERS 0x0002
646.br
647The folder is only populated with folders it contains.
648:li.FOI_WORKAREA 0x0004
649.br
650The folder is a workarea folder.
651:eul.
652
653.******************************************************
654
655:h2 res=570
656width=30%
657.wpQueryFldrFont
658:link reftype=hd res=571
659auto dependent group=2.
660:p.
661:link reftype=hd res=571.Syntax:elink.
662.br
663:link reftype=hd res=573 dependent.Returns:elink.
664.br
665:link reftype=hd res=574 dependent.Remarks:elink.
666.*.br
667.*:link reftype=hd res=315.Usage:elink.
668.*.br
669.*:link reftype=hd res=416 dependent.Example:elink.
670
671:h2 res=571
672x=30%
673width=70%
674hide
675group=2
676.wpQueryFldrFont - Syntax
677:xmp.
678/* Query the font of a folder view */
679
680thefolder /* The folder on which the method is invoked */
681fldrView /* One of OPEN_CONTENTS (1), OPEN_DETAILS (102) or OPEN_TREE (101) */
682:p.
683font=MFldrCallWPSFunc("wpQueryFldrFont",
684 theFolder, fldrView);
685:exmp.
686
687
688:h2 res=573
689x=30%
690width=70% height=55%
691group=3
692hide
693.wpQueryFldrFont - Return value
694:p.
695:hp2.font:ehp2. string
696:p.
697The return value is font of the specified folder view for example :hp2.10.Helv:ehp2..
698
699
700:h2 res=574
701x=30%
702width=70%
703hide
704group=2
705.wpQueryFldrFont - Remarks
706:p.
707There's only one font per view. All concurrent views share the same font.
708
709
710.******************************************************
711
712:h2 res=580
713width=30%
714.wpQueryFolder
715:link reftype=hd res=581
716auto dependent group=2.
717:p.
718:link reftype=hd res=581.Syntax:elink.
719.br
720:link reftype=hd res=583 dependent.Returns:elink.
721.*.br
722.*:link reftype=hd res=314 dependent.Remarks:elink.
723.*.br
724.*:link reftype=hd res=315.Usage:elink.
725.*.br
726.*:link reftype=hd res=416 dependent.Example:elink.
727
728:h2 res=581
729x=30%
730width=70%
731hide
732group=2
733.wpQueryFolder - Syntax
734:xmp.
735/* Query the folder an objects resides in */
736
737theObject /* A WPS object */
738:p.
739theFolder=MFldrCallWPSFunc("wpQueryFolder",
740 theObject);
741:exmp.
742
743
744:h2 res=583
745x=30%
746width=70% height=55%
747group=3
748hide
749.wpQueryFolder - Return value
750:p.
751:hp2.theFolder:ehp2. numeric
752:p.
753The return value is the folder a given object resides in. The pointer
754may be used with other methods.
755
756
757.******************************************************
758
759:h2 res=590
760width=30%
761.wpQueryHandle
762:link reftype=hd res=591
763auto dependent group=2.
764:p.
765:link reftype=hd res=591.Syntax:elink.
766.br
767:link reftype=hd res=593 dependent.Returns:elink.
768.*.br
769.*:link reftype=hd res=314 dependent.Remarks:elink.
770.*.br
771.*:link reftype=hd res=315.Usage:elink.
772.*.br
773.*:link reftype=hd res=416 dependent.Example:elink.
774
775:h2 res=591
776x=30%
777width=70%
778hide
779group=2
780.wpQueryHandle - Syntax
781:xmp.
782/* Query the persistent handle of an object */
783
784theObject /* A WPS object */
785:p.
786handle=MFldrCallWPSFunc("wpQueryHandle",
787 theObject);
788:exmp.
789
790
791:h2 res=593
792x=30%
793width=70% height=55%
794group=3
795hide
796.wpQueryHandle - Return value
797:p.
798:hp2.handle:ehp2. numeric
799:p.
800The return value is a persistent handle to the given object. This
801handle is unique on the system.
802
803
804.******************************************************
805
806:h2 res=600
807width=30%
808.wpQueryObjectID
809:link reftype=hd res=601
810auto dependent group=2.
811:p.
812:link reftype=hd res=601.Syntax:elink.
813.br
814:link reftype=hd res=603 dependent.Returns:elink.
815.*.br
816.*:link reftype=hd res=314 dependent.Remarks:elink.
817.*.br
818.*:link reftype=hd res=315.Usage:elink.
819.*.br
820.*:link reftype=hd res=416 dependent.Example:elink.
821
822:h2 res=601
823x=30%
824width=70%
825hide
826group=2
827.wpQueryObjectID - Syntax
828:xmp.
829/* Query the ID of an object */
830
831theObject /* A WPS object */
832:p.
833id=MFldrCallWPSFunc("wpQueryObjectID",
834 theObject);
835:exmp.
836
837
838:h2 res=603
839x=30%
840width=70% height=55%
841group=3
842hide
843.wpQueryObjectID - Return value
844:p.
845:hp2.id:ehp2. string
846:p.
847The return value is the ID of the given object or NULL. This
848ID is unique on the system for example <WP_DESKTOP>.
849
850.******************************************************
851
852:h2 res=610
853width=30%
854.wpQueryShadowedObject
855:link reftype=hd res=611
856auto dependent group=2.
857:p.
858:link reftype=hd res=611.Syntax:elink.
859.br
860:link reftype=hd res=613 dependent.Returns:elink.
861.br
862:link reftype=hd res=614 dependent.Remarks:elink.
863.*.br
864.*:link reftype=hd res=315.Usage:elink.
865.*.br
866.*:link reftype=hd res=416 dependent.Example:elink.
867
868:h2 res=611
869x=30%
870width=70%
871hide
872group=2
873.wpQueryShadowedObject - Syntax
874:xmp.
875/* Query the object a shadow links to */
876
877theShadow /* A shadow object */
878fLock /* lock flag 0/1*/
879:p.
880object=MFldrCallWPSFunc("wpQueryShadowedObject",
881 theShadow, fLock);
882:exmp.
883
884
885:h2 res=613
886x=30%
887width=70% height=55%
888group=3
889hide
890.wpQueryShadowedObject - Return value
891:p.
892:hp2.object:ehp2. numeric
893:p.
894The return value is the object the shadow links to.
895
896
897:h2 res=614
898x=30%
899width=70%
900hide
901group=2
902.wpQueryShadowedObject - Remarks
903:p.
904If fLock is 0 the queried object will go dormant when the object and the folder
905the object resides in are closed. Otherwise the object stays awake until a
906wpUnlockObject call is made. Awake objects stay in memory while dormant objects release
907their resources when not longer accessed.
908
909
910.******************************************************
911
912:h2 res=620
913width=30%
914.wpQueryStyle
915:link reftype=hd res=621
916auto dependent group=2.
917:p.
918:link reftype=hd res=621.Syntax:elink.
919.br
920:link reftype=hd res=623 dependent.Returns:elink.
921.*.br
922.*:link reftype=hd res=614 dependent.Remarks:elink.
923.*.br
924.*:link reftype=hd res=315.Usage:elink.
925.*.br
926.*:link reftype=hd res=416 dependent.Example:elink.
927
928:h2 res=621
929x=30%
930width=70%
931hide
932group=2
933.wpQueryStyle - Syntax
934:xmp.
935/* Query the style of an object */
936
937theObject /* An object */
938:p.
939style=MFldrCallWPSFunc("wpQueryStyle",
940 theObject);
941:exmp.
942
943
944:h2 res=623
945x=30%
946width=70% height=55%
947group=3
948hide
949.wpQueryStyle - Return value
950:p.
951:hp2.style:ehp2. numeric
952:p.
953The return value is a bitmask of the style flags of an object.
954:ul.
955:li.OBJSTYLE_NOMOVE 2
956.br
957Object cannot be moved.
958:li.OBJSTYLE_NOLINK 4
959.br
960Shadows can't be created
961:li.OBJSTYLE_NOCOPY 8
962.br
963Object cannot be copied.
964:li.OBJSTYLE_TEMPLATE 32
965.br
966The object is a template.
967:li.OBJSTYLE_NODELETE 64
968.br
969The object cannot be deleted.
970:li.OBJSTYLE_NOPRINT 128
971.br
972The object cannot be printed.
973:li.OBJSTYLE_NODRAG 256
974.br
975The object cannot be dragged.
976:li.OBJSTYLE_NOTVISIBLE 512
977.br
978The object is hidden.
979:li.OBJSTYLE_NOSETTINGS 1024
980.br
981There're not settings for this object.
982:li.OBJSTYLE_NORENAME 2048
983.br
984The object cannot be renamed.
985:li.OBJSTYLE_NODROPON 8192
986.br
987Other objects can't be dropped on this object.
988:li.OBJSTYLE_CUSTOMICON 16384
989.br
990Icon is destroyed when object goes dormant.
991:eul.
992
993.******************************************************
994
995:h2 res=630
996width=30%
997.wpQueryTitle
998:link reftype=hd res=631
999auto dependent group=2.
1000:p.
1001:link reftype=hd res=631.Syntax:elink.
1002.br
1003:link reftype=hd res=633 dependent.Returns:elink.
1004.br
1005:link reftype=hd res=634 dependent.Remarks:elink.
1006.*.br
1007.*:link reftype=hd res=315.Usage:elink.
1008.*.br
1009.*:link reftype=hd res=416 dependent.Example:elink.
1010
1011:h2 res=631
1012x=30%
1013width=70%
1014hide
1015group=2
1016.wpQueryTitle - Syntax
1017:xmp.
1018/* Query the title of an object */
1019
1020theObject /* An object */
1021:p.
1022title=MFldrCallWPSFunc("wpQueryTitle",
1023 theObject);
1024:exmp.
1025
1026
1027:h2 res=633
1028x=30%
1029width=70% height=55%
1030group=3
1031hide
1032.wpQueryTitle - Return value
1033:p.
1034:hp2.title:ehp2. string
1035:p.
1036This call returns the title of the object as a string.
1037
1038:h2 res=634
1039x=30%
1040width=70%
1041hide
1042group=2
1043.wpQueryTitle - Remarks
1044:p.
1045The title may differ from the real name of an object. For example
1046FAT-drives don't support long file names but the WPS may take
1047them from the EAs.
1048
1049
1050.******************************************************
1051
1052:h2 res=640
1053width=30%
1054.wpQueryType
1055:link reftype=hd res=641
1056auto dependent group=2.
1057:p.
1058:link reftype=hd res=641.Syntax:elink.
1059.br
1060:link reftype=hd res=643 dependent.Returns:elink.
1061.*.br
1062.*:link reftype=hd res=634 dependent.Remarks:elink.
1063.*.br
1064.*:link reftype=hd res=315.Usage:elink.
1065.*.br
1066.*:link reftype=hd res=416 dependent.Example:elink.
1067
1068:h2 res=641
1069x=30%
1070width=70%
1071hide
1072group=2
1073.wpQueryType - Syntax
1074:xmp.
1075/* Query the type of an object */
1076
1077theObject /* An object */
1078:p.
1079type=MFldrCallWPSFunc("wpQueryType",
1080 theObject);
1081:exmp.
1082
1083
1084:h2 res=643
1085x=30%
1086width=70% height=55%
1087group=3
1088hide
1089.wpQueryType - Return value
1090:p.
1091:hp2.type:ehp2. string
1092:p.
1093The return string contains a list of types delimited with linefeed characters.
1094For example :hp2.Plain Text\nC Code:ehp2..
1095
1096.******************************************************
1097
1098:h2 res=650
1099width=30%
1100.wpRefresh
1101:link reftype=hd res=651
1102auto dependent group=2.
1103:p.
1104:link reftype=hd res=651.Syntax:elink.
1105.br
1106:link reftype=hd res=653 dependent.Returns:elink.
1107.*.br
1108.*:link reftype=hd res=634 dependent.Remarks:elink.
1109.*.br
1110.*:link reftype=hd res=315.Usage:elink.
1111.*.br
1112.*:link reftype=hd res=416 dependent.Example:elink.
1113
1114:h2 res=651
1115x=30%
1116width=70%
1117hide
1118group=2
1119.wpRefresh - Syntax
1120:xmp.
1121/* Force a file system object to reread its information */
1122
1123theObject /* A file system object */
1124view /* The view to be refreshed (OPEN_CONTENTS, OPEN_TREE, OPEN_DETAILS or any other defined view) */
1125reserved /* reserved parameter, must be 0 */
1126:p.
1127rc=MFldrCallWPSFunc("wpRefresh",
1128 theObject, view, reserved);
1129:exmp.
1130
1131
1132:h2 res=653
1133x=30%
1134width=70% height=55%
1135group=3
1136hide
1137.wpRefresh - Return value
1138:p.
1139:hp2.rc:ehp2. numeric
1140:p.
1141Returns 0 if an error occurs.
1142
1143
1144.******************************************************
1145
1146:h2 res=660
1147width=30%
1148.wpSaveDeferred
1149:link reftype=hd res=661
1150auto dependent group=2.
1151:p.
1152:link reftype=hd res=661.Syntax:elink.
1153.br
1154:link reftype=hd res=663 dependent.Returns:elink.
1155.br
1156:link reftype=hd res=664 dependent.Remarks:elink.
1157.*.br
1158.*:link reftype=hd res=315.Usage:elink.
1159.*.br
1160.*:link reftype=hd res=416 dependent.Example:elink.
1161
1162:h2 res=661
1163x=30%
1164width=70%
1165hide
1166group=2
1167.wpSaveDeferred - Syntax
1168:xmp.
1169/* Save the instance data of an object asynchronously */
1170
1171theObject /* A WPS object */
1172:p.
1173rc=MFldrCallWPSFunc("wpSaveDeferred",
1174 theObject);
1175:exmp.
1176
1177
1178:h2 res=663
1179x=30%
1180width=70% height=55%
1181group=3
1182hide
1183.wpSaveDeferred - Return value
1184:p.
1185:hp2.rc:ehp2. numeric
1186:p.
1187Returns 0 if an error occurs.
1188
1189
1190:h2 res=664
1191x=30%
1192width=70%
1193hide
1194group=2
1195.wpSaveDeferred - Remarks
1196:p.
1197The instance data is saved on a separate thread in the background when the system is idle.
1198If it's necessary to save critical data immediately use wpSaveImmediate.
1199
1200
1201
1202:h2 res=670
1203width=30%
1204.wpSaveImmediate
1205:link reftype=hd res=671
1206auto dependent group=2.
1207:p.
1208:link reftype=hd res=671.Syntax:elink.
1209.br
1210:link reftype=hd res=673 dependent.Returns:elink.
1211.br
1212:link reftype=hd res=674 dependent.Remarks:elink.
1213.*.br
1214.*:link reftype=hd res=315.Usage:elink.
1215.*.br
1216.*:link reftype=hd res=416 dependent.Example:elink.
1217
1218:h2 res=671
1219x=30%
1220width=70%
1221hide
1222group=2
1223.wpSaveImmediate - Syntax
1224:xmp.
1225/* Save the instance data of an object synchronously */
1226
1227theObject /* A WPS object */
1228:p.
1229rc=MFldrCallWPSFunc("wpSaveImmediate",
1230 theObject);
1231:exmp.
1232
1233
1234:h2 res=673
1235x=30%
1236width=70% height=55%
1237group=3
1238hide
1239.wpSaveImmediate - Return value
1240:p.
1241:hp2.rc:ehp2. numeric
1242:p.
1243Returns 0 if an error occurs.
1244
1245
1246:h2 res=674
1247x=30%
1248width=70%
1249hide
1250group=2
1251.wpSaveImmediate - Remarks
1252:p.
1253The instance data is saved immediate when calling this method. In general
1254wpSaveDeferred should be used because when using that method the data is written
1255when the system is idle.
1256
1257.******************************************************
1258
1259:h2 res=680
1260width=30%
1261.wpSetDefaultView
1262:link reftype=hd res=681
1263auto dependent group=2.
1264:p.
1265:link reftype=hd res=681.Syntax:elink.
1266.br
1267:link reftype=hd res=683 dependent.Returns:elink.
1268.br
1269:link reftype=hd res=684 dependent.Remarks:elink.
1270.*.br
1271.*:link reftype=hd res=315.Usage:elink.
1272.*.br
1273.*:link reftype=hd res=416 dependent.Example:elink.
1274
1275:h2 res=681
1276x=30%
1277width=70%
1278hide
1279group=2
1280.wpSetDefaultView - Syntax
1281:xmp.
1282/* Set the default view of an object */
1283
1284theObject /* A WPS object */#
1285view /* The new default view */
1286:p.
1287rc=MFldrCallWPSFunc("wpSetDefaultView",
1288 theObject, view);
1289:exmp.
1290
1291
1292:h2 res=683
1293x=30%
1294width=70% height=55%
1295group=3
1296hide
1297.wpSetDefaultView - Return value
1298:p.
1299:hp2.rc:ehp2. numeric
1300:p.
1301Returns 0 if an error occurs.
1302
1303
1304:h2 res=684
1305x=30%
1306width=70%
1307hide
1308group=2
1309.wpSetDefaultView - Remarks
1310:p.
1311The object may be set to one of the following views.
1312
1313:ul.
1314:li.OPEN_CONTENTS: 1
1315.br
1316Open in contents view (icon).
1317:li.OPEN_DEFAULT: 0
1318.br
1319Same as doubleclick.
1320:li.OPEN_DETAILS: 102
1321.br
1322Details view.
1323:li.OPEN_HELP: 3
1324.br
1325Display the help panel.
1326:li.OPEN_RUNNING: 4
1327.br
1328Execute the object.
1329:li.OPEN_SETTINGS: 2
1330.br
1331Open the settings of the object.
1332:li.OPEN_TREE: 101
1333.br
1334Unknown view.
1335:li.OPEN_USER: 0x6500 or higher
1336.br
1337A user view introduced by a subclass.
1338:eul.
1339
1340
1341.******************************************************
1342
1343:h2 res=690
1344width=30%
1345.wpSetLinkToObject
1346:link reftype=hd res=681
1347auto dependent group=2.
1348:p.
1349:link reftype=hd res=691.Syntax:elink.
1350.br
1351:link reftype=hd res=693 dependent.Returns:elink.
1352.*.br
1353.*:link reftype=hd res=684 dependent.Remarks:elink.
1354.*.br
1355.*:link reftype=hd res=315.Usage:elink.
1356.*.br
1357.*:link reftype=hd res=416 dependent.Example:elink.
1358
1359:h2 res=691
1360x=30%
1361width=70%
1362hide
1363group=2
1364.wpSetLinkToObject - Syntax
1365:xmp.
1366/* This method links the shadow to
1367 the specified object */
1368
1369theShadow
1370theObject /* A WPS object to link to */
1371:p.
1372rc=MFldrCallWPSFunc("wpSetLinkToObject",
1373 theShadow, theObject);
1374:exmp.
1375
1376
1377:h2 res=693
1378x=30%
1379width=70% height=55%
1380group=3
1381hide
1382.wpSetLinkToObject - Return value
1383:p.
1384:hp2.rc:ehp2. numeric
1385:p.
1386Returns 0 if an error occurs.
1387
1388
1389.******************************************************
1390
1391:h2 res=700
1392width=30%
1393.wpSetStyle
1394:link reftype=hd res=701
1395auto dependent group=2.
1396:p.
1397:link reftype=hd res=701.Syntax:elink.
1398.br
1399:link reftype=hd res=703 dependent.Returns:elink.
1400.br
1401:link reftype=hd res=704 dependent.Remarks:elink.
1402.*.br
1403.*:link reftype=hd res=315.Usage:elink.
1404.*.br
1405.*:link reftype=hd res=416 dependent.Example:elink.
1406
1407:h2 res=701
1408x=30%
1409width=70%
1410hide
1411group=2
1412.wpSetStyle - Syntax
1413:xmp.
1414/* Set the style of an object */
1415
1416theObject /* A WPS object */
1417newStyle /* The new style of the object */
1418:p.
1419rc=MFldrCallWPSFunc("wpSetStyle",
1420 theObject, newStyle);
1421:exmp.
1422
1423
1424:h2 res=703
1425x=30%
1426width=70% height=55%
1427group=3
1428hide
1429.wpSetStyle - Return value
1430:p.
1431:hp2.rc:ehp2. numeric
1432:p.
1433Returns 0 if an error occurs.
1434
1435:h2 res=704
1436x=30%
1437width=70%
1438hide
1439group=2
1440.wpSetStyle - Remarks
1441:p.
1442The following flags may be ored together.
1443:ul.
1444:li.OBJSTYLE_NOMOVE 2
1445.br
1446Object cannot be moved.
1447:li.OBJSTYLE_NOLINK 4
1448.br
1449Shadows can't be created
1450:li.OBJSTYLE_NOCOPY 8
1451.br
1452Object cannot be copied.
1453:li.OBJSTYLE_TEMPLATE 32
1454.br
1455The object is a template.
1456:li.OBJSTYLE_NODELETE 64
1457.br
1458The object cannot be deleted.
1459:li.OBJSTYLE_NOPRINT 128
1460.br
1461The object cannot be printed.
1462:li.OBJSTYLE_NODRAG 256
1463.br
1464The object cannot be dragged.
1465:li.OBJSTYLE_NOTVISIBLE 512
1466.br
1467The object is hidden.
1468:li.OBJSTYLE_NOSETTINGS 1024
1469.br
1470There're not settings for this object.
1471:li.OBJSTYLE_NORENAME 2048
1472.br
1473The object cannot be renamed.
1474:li.OBJSTYLE_NODROPON 8192
1475.br
1476Other objects can't be dropped on this object.
1477:li.OBJSTYLE_CUSTOMICON 16384
1478.br
1479Icon is destroyed when object goes dormant.
1480:eul.
1481
Note: See TracBrowser for help on using the repository browser.