Share via


Service.onGetChildrenByFormatComplete event

The onGetChildrenByFormatComplete event occurs, and a callback handler is invoked, when a Service.GetChildrenByFormat method operation is completed.

Syntax

Service.onGetChildrenByFormatComplete(
  hrStatus,
  childrenCollection
)

Parameters

hrStatus

Contains the overall status of the enumeration operation (success or failure).

childrenCollection

Contains the child objects returned by the Service.GetChildrenByFormat method. If no children match the requested formats in the Service.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 Service.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.
Service.onGetChildrenByFormatComplete = HandlerFunction;

Requirements

Minimum supported client
Windows 7 [desktop apps only]
Minimum supported server
Windows Server 2008 R2 [desktop apps only]

See also

childrenCollection Object

Service Object

WPDObject