IUriBuilder::CreateUriWithFlags method

Returns a new IUri object based on modifications to the original IUri.

Syntax


HRESULT CreateUriWithFlags(
  [in]  DWORD     dwCreateFlags,
  [in]  DWORD     dwUriBuilderFlags,
  [in]  DWORD     dwAllowEncodingPropertyMask,
  [in]  DWORD_PTR dwReserved,
  [out] IUri      **ppIUri
);

Parameters

dwCreateFlags [in]

DWORD that combines Uri_CREATE flags, which control the creation of the IUri object. Refer to the CreateUri function for a description of these flags.

dwUriBuilderFlags [in]

DWORD for flags specific to IUriBuilder, or zero.

UriBuilder_USE_ORIGINAL_FLAGS (0x00000001)

Use the create flags from the original IUri, if they are available.

dwAllowEncodingPropertyMask [in]

DWORD that may contain a combination of the following flags, or zero. Reserved characters in the specified properties may be percent encoded, if required.

Uri_HAS_USER_NAME (0x00000800)

Allow encoding of Uri_PROPERTY_USER_NAME.

Uri_HAS_PASSWORD (0x00000040)

Allow encoding of Uri_PROPERTY_PASSWORD.

Uri_HAS_HOST (0x00000020)

Allow encoding of Uri_PROPERTY_HOST.

Uri_HAS_PATH (0x00000080)

Allow encoding of Uri_PROPERTY_PATH.

Uri_HAS_QUERY (0x00000100)

Allow encoding of Uri_PROPERTY_QUERY.

Uri_HAS_FRAGMENT (0x00000010)

Allow encoding of Uri_PROPERTY_FRAGMENT.

dwReserved [in]

Reserved. Must be set to 0.

ppIUri [out]

Address of pointer variable of type IUri that receives the new object.

Return value

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

Remarks

CreateUriWithFlags was introduced in Windows Internet Explorer 7.

If no changes are made, this method may return a pointer to the original IUri object (after incrementing the reference count).

Requirements

Minimum supported client

Windows XP with SP2

Minimum supported server

Windows Server 2003

Product

Internet Explorer 7

Header

Urlmon.h

IDL

Urlmon.idl

DLL

Urlmon.dll

See also

IUriBuilder
Reference
CreateUri
CreateUriSimple

 

 

Show: