DescribeList Method

Describes the schema of a list.

Syntax

spsite.describeList(list, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The Column event will fire for each column in the schema.

Note: When DescribeList is called the ColumnUpdateOp will be set to cmoUpdate by default for all Columns in Columns.