ID3DXFileSaveData::GetName method

Retrieves the name of this ID3DXFileSaveData file data node.

Syntax

HRESULT GetName(
  [in]      LPSTR  szName,
  [in, out] SIZE_T *puiSize
);

Parameters

szName [in]

Type: LPSTR

Address of a pointer to receive the name of this file data node. If this parameter is NULL, then puiSize will return the size of the string. If szName points to valid memory, the name of this file data node will be copied into szName up to the number of characters given by puiSize .

puiSize [in, out]

Type: SIZE_T*

Pointer to the size of the string that represents the name of this file data node. This parameter can be NULL if szName provides a reference to the name. This parameter will return the size of the string if szName is NULL.

Return value

Type: HRESULT

If the method succeeds, the return value is S_OK. If the method fails, the following value will be returned: D3DXFERR_BADVALUE.

Remarks

For this method to succeed, either szName or puiSize must be non-NULL.

Requirements

See also

ID3DXFileSaveData