IDirectPlay8Address::AddComponent

Adds a component to the address. If the component is part of the address, it is replaced by the new value in this call.

Values are specified in native formats when making this call. Therefore, the lpvData parameter should be a recast pointer to a variable that holds the data in the native format. For example, if the component is a GUID, the lpvData parameter should be a recast pointer to a GUID.

This method validates that the predefined component types are the right format.

HRESULT AddComponent(
const WCHAR *const pwszName,
const void *const lpvData,
const DWORD dwDataSize,
const DWORD dwDataType 
);

Parameters

pwszName

[in] NULL-terminated Unicode string that contains the key for the component.

lpvData

[in] Pointer to a buffer that contains the value associated with the specified key. Data should be specified in its native format.

dwDataSize

[in] Size, in bytes, of the data in the buffer located at lpvData. The size depends on the data type. If the size is not specified correctly, the method returns DPNERR_INVALIDPARAM.

DWORD

Size = sizeof( DWORD )

GUID

Size = sizeof( GUID )

String

Size = size of the string in bytes, including NULL terminator.

dwDataType

[in] Data type of the value associated with this key. The data type can be one of the following:

DPNA_DATATYPE_STRING

Data is a NULL-terminated string.

DPNA_DATATYPE_DWORD

Data is a DWORD.

DPNA_DATATYPE_GUID

Data is a GUID.

DPNA_DATATYPE_BINARY

Data is in raw binary format.

Return Values

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

Remarks

See DirectPlay Addressing for a discussion of various address components and their keys.

Requirements

  Windows NT/2000/XP: Available as a redistributable for Windows 2000 and later.
  Windows 98/Me: Available as a redistributable for Windows 98 and later.
  Header: Declared in Dpaddr.h.