Share via

GetRedirectedURL Method

  • Article

The GetRedirectedUrl method returns a redirected URL for the current item.

Syntax
HRESULT GetRedirectedURL(
  WCHARwszRedirectedURL[],
  DWORDdwSize,
  DWORD*pdwLength);
Parameters
  • WszRedirectedURL[]
    [out, length_is(*pdwLength), size_is(dwSize)] Pointer to a wszRedirectedURL that contains a string buffer where the redirect URL will be written.
  • dwSize
    [in] Pointer to a DWORD that contains the size of the wszRedirectedURL string buffer.
  • pdwLength
    [out] Pointer to a DWORD that contains the number of characters written to the wszRedirectedURL string buffer.
Return Value

This method should return PRTH_E_NOT_REDIRECTED if not implemented.

For a list of error messages returned by SharePoint Portal Server Protocol Handlers, see Error Messages.

Remarks

If the GetRedirectedUrl method is implemented, the URL that is passed to CreateAccessor will be redirected to the value returned by this method. All subsequent relative URL links will be processed based on the redirected URL.

Example

To see this method in a fuller context, see Protocol HandlerSample.