SPList Class

Properties   Methods   Events   Configuration Settings   Errors  

Manages the list items and attachments of the list items relating to a specific SharePoint List.

Class Name

InSP_SPList

Procedural Interface

 insp_splist_open();
 insp_splist_close($res);
 insp_splist_register_callback($res, $id, $function);
 insp_splist_get_last_error($res);
 insp_splist_get_last_error_code($res);
 insp_splist_set($res, $id, $index, $value);
 insp_splist_get($res, $id, $index);
 insp_splist_do_addattachment($res, $itemid, $filename);
 insp_splist_do_additems($res);
 insp_splist_do_config($res, $configurationstring);
 insp_splist_do_deleteattachment($res, $itemid, $filename);
 insp_splist_do_deleteitems($res);
 insp_splist_do_doevents($res);
 insp_splist_do_getattachment($res, $remotefile);
 insp_splist_do_getitemfield($res, $itemindex, $fieldname);
 insp_splist_do_getxattribute($res, $xpath);
 insp_splist_do_interrupt($res);
 insp_splist_do_listattachments($res, $itemid);
 insp_splist_do_listitems($res);
 insp_splist_do_reset($res);
 insp_splist_do_sendcustomrequest($res, $url, $requestdata, $otherheaders);
 insp_splist_do_updateitems($res);

Remarks

The SPList class allows you to manage SharePoint Lists. While it can also be used to manage SharePoint Libraries, the SPDocuments class is specifically designed for usage with individual SharePoint Documents.

To get started, first set the URL, User, and Password properties to point the class to your Site, and then set List to the Id of a specific SharePoint List to manage. To retrieve Ids for all of the Lists on your Site, use the SPSite class.

When ListItems is called, the Item event will fire for each item in the specified list and Items will be populated. Specific fields of an item can be retrieved using the GetItemField method. Use ListAttachments to list the attachments of a specific item, which will be provided in the Attachment event.

Use the AddItems, DeleteItems, and UpdateItems methods to add, delete, and update items of a specific List. AddAttachment and DeleteAttachment can be used to add and delete attachments from a specific item in a List.

About SharePoint Online Services

When using Microsoft SharePoint Online you must set AuthScheme to authSPOnline (7).