Command.IncrementCacheUsage Method

[IncrementCacheUsage] is used to notify the command that data is being cached that can be sent to the client. Once the command caches enough data, this method returns [True] to the caller telling them that it has exceeded the maximum requested cache size. If the caller can stop execution and return its current data, it should do so at this point.

Namespace:  Microsoft.TeamFoundation.Framework.Server
Assembly:  Microsoft.TeamFoundation.Framework.Server (in Microsoft.TeamFoundation.Framework.Server.dll)

Syntax

'Declaration
Public Function IncrementCacheUsage ( _
    bytes As Integer _
) As Boolean
public bool IncrementCacheUsage(
    int bytes
)
public:
bool IncrementCacheUsage(
    int bytes
)
member IncrementCacheUsage : 
        bytes:int -> bool
public function IncrementCacheUsage(
    bytes : int
) : boolean

Parameters

  • bytes
    Type: System.Int32

    Number of bytes being added to the command cache.

Return Value

Type: System.Boolean
[True] if the cache has exceeded the maximum cache size.
[False] if the cache is not yet full.

.NET Framework Security

See Also

Reference

Command Class

Microsoft.TeamFoundation.Framework.Server Namespace