Microsoft DirectX 9.0

IDirectXFileObject::GetName Method

Retrieves a pointer to a Microsoft?DirectX?file object's name.


HRESULT GetName(      

    LPSTR pstrNameBuf,     LPDWORD pdwBufLen );


[out] Pointer to the buffer in which the DirectX file object's name will be copied. Set to NULL if only the buffer length is needed.
[in, out] Pointer to a DWORD specifying the length of the buffer pointed to by pstrNameBuf. The pdwBufLen parameter value will be modified to the buffer length needed to hold the object's name even if pstrNameBuf is NULL. In either case, the function will return DXFILEERR_BADVALUE if the original value of pdwBufLen is not as large as or larger than the length needed to hold the object's name.

Return Value

If the method succeeds, the return value is DXFILE_OK.

If the method fails, the return value can be one of the following values.

DXFILEERR_BADALLOCMemory allocation failed.
DXFILEERR_BADVALUEParameter is invalid.

© 2002 Microsoft Corporation. All rights reserved.