IDirectPlay8Address::BuildFromURLA Method

DirectPlay

 
Microsoft DirectX 9.0 SDK Update (Summer 2003)

IDirectPlay8Address::BuildFromURLA Method


Sets the object equal to the specified Microsoft® DirectPlay®   URL string. It erases the contents of the object.

Syntax

HRESULT BuildFromURLA(      
    CHAR *pszSourceURL );

Parameters

pszSourceURL
[in] Pointer to a NULL-terminated ANSI string that contains a properly formatted DirectPlay address.

Return Value

Returns S_OK if successful, or one of the following error values.

DPNERR_INVALIDPOINTERPointer specified as a parameter is invalid.
DPNERR_INVALIDURLSpecified string is not a valid DirectPlayURL.
DPNERR_NOTALLOWEDThis function is not allowed on this object.

Remarks

The Dpaddr.h header file defines a number of standard strings that you can use to construct your URL instead using a literal string. All of the string names have the form DPNA_xxx. For example, DPNA_HEADER can be used in place of L"x-directplay:/" for the URL header.



© 2003 Microsoft Corporation. All rights reserved.