Edit

Share via

ISingleItemException::GetItemId method (winsync.h)

  • Article

Gets the ID of the item that is specified in the exception.

Syntax

HRESULT GetItemId(
  [in, out] BYTE  *pbItemId,
  [in, out] DWORD *pcbIdSize
);

Parameters

[in, out] pbItemId

Returns the ID of the item that is specified in the exception.

[in, out] pcbIdSize

Specifies the number of bytes in pbItemId. Returns the number of bytes required to retrieve the ID when pbItemId is too small, or returns the number of bytes written.

Return value

The possible return codes include, but are not limited to, the values shown in the following table.

Return code Description
S_OK
 The method succeeded.
E_INVALIDARG
HRESULT_FROM_WIN32(ERROR_MORE_DATA)
 pbItemId is too small. In this case, the required number of bytes is returned in pcbIdSize.

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Target Platform Windows
Header winsync.h

See also

ISingleItemException Interface