Export (0) Print
Expand All

IWICMetadataQueryReader::GetLocation method

Retrieves the current path relative to the root metadata block.

Syntax


HRESULT GetLocation(
  [in]       UINT cchMaxLength,
  [in, out]  WCHAR *wzNamespace,
  [out]      UINT *pcchActualLength
);

Parameters

cchMaxLength [in]

Type: UINT

The length of the wzNamespace buffer.

wzNamespace [in, out]

Type: WCHAR*

Pointer that receives the current namespace location.

pcchActualLength [out]

Type: UINT*

The actual buffer length that was needed to retrieve the current namespace location.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

If you pass NULL to wzNamespace, GetLocation ignores cchMaxLength and returns the required buffer length to store the path in the variable that pcchActualLength points to.

If the query reader is relative to the top of the metadata hierarchy, it will return a single-char string.

If the query reader is relative to a nested metadata block, this method will return the path to the current query reader.

Requirements

Minimum supported client

Windows XP with SP2, Windows Vista [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2008 [desktop apps | Windows Store apps]

Header

Wincodec.h

IDL

Wincodec.idl

Library

Windowscodecs.lib

DLL

Windowscodecs.dll

See also

IWICMetadataQueryReader
Conceptual
WIC Metadata Overview
Overview of Reading and Writing Image Metadata

 

 

Community Additions

ADD
Show:
© 2014 Microsoft