Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

CheckNameLegalDOS8Dot3 function

Determines whether the specified name can be used to create a file on a FAT file system.

Syntax


BOOL WINAPI CheckNameLegalDOS8Dot3(
  _In_       LPCTSTR lpName,
  _Out_opt_  LPSTR lpOemName,
  _In_       DWORD OemNameSize,
  _Out_opt_  PBOOL pbNameContainsSpaces,
  _Out_      PBOOL pbNameLegal
);

Parameters

lpName [in]

The file name, in 8.3 format.

lpOemName [out, optional]

A pointer to a buffer that receives the OEM string that corresponds to Name. This parameter can be NULL.

OemNameSize [in]

The size of the lpOemName buffer, in characters. If lpOemName is NULL, this parameter must be 0 (zero).

pbNameContainsSpaces [out, optional]

Indicates whether or not a name contains spaces. This parameter can be NULL. If the name is not a valid 8.3 FAT file system name, this parameter is undefined.

pbNameLegal [out]

If the function succeeds, this parameter indicates whether a file name is a valid 8.3 FAT file name when the current OEM code page is applied to the file name.

Return value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is 0 (zero). To get extended error information, call GetLastError.

Remarks

This function can be used to determine whether or not a file name can be passed to a 16-bit Windows-based application or an MS-DOS-based application.

In Windows 8 and Windows Server 2012, this function is supported by the following technologies.

TechnologySupported

Server Message Block (SMB) 3.0 protocol

Yes

SMB 3.0 Transparent Failover (TFO)

See remarks

SMB 3.0 with Scale-out File Shares (SO)

See remarks

Cluster Shared Volume File System (CsvFS)

Yes

Resilient File System (ReFS)

Yes

 

Note that SMB 3.0 does not support short names on shares with continuous availability capability, so function will always return zero (fail).

Requirements

Minimum supported client

Windows Vista, Windows XP with SP1 [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

WinBase.h (include Windows.h)

Library

Kernel32.lib

DLL

Kernel32.dll

Unicode and ANSI names

CheckNameLegalDOS8Dot3W (Unicode) and CheckNameLegalDOS8Dot3A (ANSI)

See also

File Management Functions
GetOEMCP

 

 

Community Additions

Show:
© 2014 Microsoft