Home > Class Reference > %SYS namespace > %Net.LDAP.Client.ValueList

%Net.LDAP.Client.ValueList

class %Net.LDAP.Client.ValueList extends %Library.RegisteredObject, %Collection.AbstractIterator

WARNING: This Class and its methods has been deprecated, please use the %SYS.LDAP class.


Attribute Value. Used by PropList, or Entry classes. See %Net.LDAP.Client.PropList.Insert() or %Net.LDAP.Client.Entry.GetAttribValue() methods.

Method Inventory (Including Private)

Methods (Including Private)

method Delete(Index As %Integer) as %Boolean [ Language = objectscript ]
Delete the i-th entry.
method GetAt(Key As %String = "") as %RawString [ Language = objectscript ]
Finds and returns the value associated with key. Null string if no value is found.
method GetLen(index As %Integer) as %Boolean [ Language = objectscript ]
Get the i-th entry len.
method GetNext(ByRef key As %RawString) as %RawString [ Language = objectscript ]
Moves to the next key at the location in the iteration, and returns the associated value. If the key is a null string (""), it starts from the beginning. The value of key, which is passed by reference, is updated to the key value of the index or null string ("") if key is at the end of the list.
method GetNumItems() as %Integer [ Language = objectscript ]
Get number of value entries.
method GetPartialValue(index As %Integer, StartPos As %Integer, NumBytes As %Integer = 32767) as %String [ Language = objectscript ]
Get partial value as %string. Use to extract large values. Note start position is zero based!!
method GetValue(index As %Integer) as %RawString [ Language = objectscript ]
Get the i-th value.
method GetValueInStream(index As %Integer, stream As %Library.AbstractStream) as %Status [ Language = objectscript ]
Get the i-th value into a stream. Returns $$$OK on success.
method Insert(Value As %RawString) as %Status [ Language = objectscript ]
Append a value to this value list object. Return $$$OK status, otherwise related error.

If the value is an abstract stream it will append the stream to the value list. If the value is an abstract iterator it will iterate and store its contents. Otherwise it will append/store the passed data as string or binary value.

Returns the next key at the location in the iteration. If key is a null string (""), then Next returns the first index (one). Return "" string if key is out of bounds.

Inherited Members

Inherited Methods (Including Private)

FeedbackOpens in a new window