Storage.onGetChildrenByFormatComplete event
The onGetChildrenByFormatComplete event occurs, and a callback handler is invoked, when a Storage.GetChildrenByFormat method operation has completed.
Syntax
Storage.onGetChildrenByFormatComplete(
hrStatus,
childrenCollection
)
Parameters
-
hrStatus
-
Contains the overall status of the enumeration operation (success or failure).
-
childrenCollection
-
Contains the child objects returned by the Storage.GetChildrenByFormat method. If no children match the requested formats in the Storage.GetChildrenByFormat method operation, this collection will be empty.
Return value
This event does not return a value.
Remarks
To enable asynchronous behavior, set the handler for this event before calling the Storage.GetChildrenByFormat method.
Examples
The following code shows the handler-function syntax for the onGetChildrenByFormatComplete event.
function HandlerFunction(hrStatus, childrenCollection)
{
// Code to handle a completed asynchronous
// GetChildrenByFormat operation.
}
// Set the event handler.
Storage.onGetChildrenByFormatComplete = HandlerFunction;
Requirements
| Minimum supported client |
Windows 7 [desktop apps only] |
| Minimum supported server |
Windows Server 2008 R2 [desktop apps only] |