urlGetPartA 函数 (shlwapi.h)

  • 项目

接受 URL 字符串并返回该 URL 的指定部分。

语法

LWSTDAPI UrlGetPartA(
  [in]      PCSTR pszIn,
  [out]     PSTR  pszOut,
  [in, out] DWORD *pcchOut,
            DWORD dwPart,
            DWORD dwFlags
);

参数

[in] pszIn

类型： PCTSTR

包含 URL 的最大长度为 null 的字符串INTERNET_MAX_URL_LENGTH。

[out] pszOut

类型： PTSTR

指向缓冲区的指针，当此函数成功返回时，该缓冲区接收一个以 null 结尾的字符串，其中包含 URL 的指定部分。

[in, out] pcchOut

类型： DWORD*

指向某个值的指针，该值在输入时设置为 pszOut 缓冲区中的字符数。 当此函数成功返回时，该值取决于函数是成功还是返回E_POINTER。 对于其他返回值，此参数的值毫无意义。

dwPart

类型：DWORD

指定要检索的 URL 的哪一部分的标志。 它可以具有以下值之一。

URL_PART_HOSTNAME

主机名。

URL_PART_PASSWORD

密码。

URL_PART_PORT

端口号。

URL_PART_QUERY

URL 的查询部分。

URL_PART_SCHEME

URL 方案。

URL_PART_USERNAME

用户名。

dwFlags

类型：DWORD

除了 dwPart 指定的部件之外，还可以设置一个标志，以保留 URL 方案。

URL_PARTFLAG_KEEPSCHEME

保留 URL 方案。

返回值

类型： HRESULT

如果成功，则返回S_OK。 pcchOut 指向的值将设置为写入输出缓冲区的字符数，不包括终止 NULL。 如果缓冲区太小，则返回E_POINTER， 并且 pcchOut 指向的值将设置为缓冲区必须能够包含的最小字符数，包括终止 NULL 字符。 否则，将返回 COM 错误值。

注解

注意

shlwapi.h 标头将 UrlGetPart 定义为别名，该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将非特定编码别名的使用与非非特定编码的代码混合使用可能会导致不匹配，从而导致编译或运行时错误。 有关详细信息，请参阅 函数原型的约定。

要求

   
最低受支持的客户端 Windows 2000 专业版、Windows XP [仅限桌面应用]
最低受支持的服务器 Windows 2000 Server [仅限桌面应用]
目标平台 Windows
标头 shlwapi.h
Library Shlwapi.lib
DLL Shlwapi.dll (5.0 或更高版本)