Depth Property
The depth associated with the current operation.
Syntax
ANSI (Cross Platform) int GetDepth();
int SetDepth(int iDepth); Unicode (Windows) INT GetDepth();
INT SetDepth(INT iDepth);
Possible Values
DP_UNSPECIFIED(0),
DP_RESOURCE_ONLY(1),
DP_IMMEDIATE_CHILDREN(2),
DP_INFINITY(3)
@property (nonatomic,readwrite,assign,getter=depth,setter=setDepth:) int depth; - (int)depth; - (void)setDepth:(int)newDepth;
Possible Values
DP_UNSPECIFIED(0),
DP_RESOURCE_ONLY(1),
DP_IMMEDIATE_CHILDREN(2),
DP_INFINITY(3)
#define PID_CALDAV_DEPTH 30 IPWORKS_EXTERNAL void* IPWORKS_CALL IPWorks_CalDAV_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal); IPWORKS_EXTERNAL int IPWORKS_CALL IPWorks_CalDAV_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);
Default Value
0
Remarks
This property defines how deep to operate within a collection. When performing certain operations on resource collections, the class will use Depth to instruct the server on how deep to operate within the collection. Depth is an enumerated type with the following possible values:
| dpUnspecified (0) | The server will use the protocol default depth for the operation (this is normally "infinity"). |
| dpResourceOnly (1) | The server will operate only on the collection resource URI, and not on any of its internal member resources. |
| dpImmediateChildren (2) | The server will operate on the collection resource URI and all of its immediate member resources (but on none of their member resources). |
| dpInfinity (3) | The server will recursively operate on the target resource URI and all of its internal member URIs through all levels of the collection hierarchy. |
Depth is used when performing the following operations: LockCalendar, MoveCalendarEvent, CopyCalendarEvent, and GetCalendarReport
Data Type
Integer