Servertec
Foundation Classes
1.3.3 09/04/2005

stec.sfc.Win32
Class NetworkResourceEnumerator

java.lang.Object
  extended by stec.sfc.Win32.NetworkResourceEnumerator

public final class NetworkResourceEnumerator
extends java.lang.Object

Represents an enumeration of resources on the network.

Since:
1.2.0 12/03/2002
See Also:
Network

Constructor Summary
NetworkResourceEnumerator(int scope, int resource_type, int usage, int display_type, java.lang.String provider, java.lang.String local_name, java.lang.String remote_name)
          Constructs a new enumeration of the specified resources on the network.
 
Method Summary
 void close()
          Closes the enumeration.
 java.lang.String getComment()
          Returns any comment associated with the current resource.
 int getDisplayType()
          Returns the current NetworkResourceDisplayType.
 java.lang.String getLocalName()
          Returns the current resource's local name.
 java.lang.String getProvider()
          Returns the current provider.
 java.lang.String getRemoteName()
          Returns the current resource's remote name.
 int getResourceType()
          Returns the current NetworkResourceType.
 int getScope()
          Returns the current NetworkResourceScope.
 int getUsage()
          Returns the current NetworkResourceUsage.
 boolean isOpen()
          Returns whether this enumeration is open.
 boolean next()
          Fowards the enumeration with blocking and returns whether a next resource exists.
 boolean next(long timeout)
          Fowards the enumeration without blocking and returns whether a next resource exists.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NetworkResourceEnumerator

public NetworkResourceEnumerator(int scope,
                                 int resource_type,
                                 int usage,
                                 int display_type,
                                 java.lang.String provider,
                                 java.lang.String local_name,
                                 java.lang.String remote_name)
                          throws java.io.IOException
Constructs a new enumeration of the specified resources on the network.

Throws:
java.io.IOException
Method Detail

close

public final void close()
                 throws java.io.IOException
Closes the enumeration.

Throws:
java.io.Exception - if any exception occurs.
java.io.IOException

next

public final boolean next(long timeout)
                   throws java.io.IOException
Fowards the enumeration without blocking and returns whether a next resource exists.

Parameters:
timeout - the number of milliseconds to wait for a resource's information to be retrieved.
Throws:
java.io.Exception - if any exception occurs.
java.io.IOException

next

public final boolean next()
                   throws java.io.IOException
Fowards the enumeration with blocking and returns whether a next resource exists.

Throws:
java.io.Exception - if any exception occurs.
java.io.IOException

isOpen

public final boolean isOpen()
Returns whether this enumeration is open.


getProvider

public final java.lang.String getProvider()
Returns the current provider.

Returns:
the current provider. null if none.

getLocalName

public final java.lang.String getLocalName()
Returns the current resource's local name.

Returns:
the current resource's local name. null if none.

getRemoteName

public final java.lang.String getRemoteName()
Returns the current resource's remote name.

Returns:
the current resource's remote name. null if none.

getComment

public final java.lang.String getComment()
Returns any comment associated with the current resource.

Returns:
any comment associated with the current resource. null if none.

getScope

public final int getScope()
Returns the current NetworkResourceScope.

Returns:
the current NetworkResourceScope.

getResourceType

public final int getResourceType()
Returns the current NetworkResourceType.

Returns:
the current NetworkResourceType.

getDisplayType

public final int getDisplayType()
Returns the current NetworkResourceDisplayType.

Returns:
the current NetworkResourceDisplayType.

getUsage

public final int getUsage()
Returns the current NetworkResourceUsage.

Returns:
the current NetworkResourceUsage.

Servertec
Foundation Classes
1.3.3 09/04/2005

Copyright © 2001-2005 Servertec. All rights reserved.