WdsCliGetTransferSize function (wdsclientapi.h)

Returns the size of the current file transfer.

Syntax

HRESULT WDSCLIAPI WdsCliGetTransferSize(
  [in]  HANDLE     hIfh,
  [out] PULONGLONG pullValue
);

Parameters

[in] hIfh

A find handle returned by the WdsCliFindFirstImage function. The image referenced by the find handle can be advanced using the WdsCliFindNextImage function.

[out] pullValue

A pointer to a value that contains the size of the current transfer.

Return value

If the function succeeds, the return is S_OK.

Remarks

This value is valid until the WdsCliFindNextImage or WdsCliClose function is used to change or close the current handle.

Requirements

   
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header wdsclientapi.h
Library WdsClientApi.lib
DLL WdsClientAPI.dll

See also

WdsCliClose

WdsCliFindFirstImage

WdsCliFindNextImage

Windows Deployment Services Client Functions