FSH UPPERCASE: Difference between revisions
Created page with "This function is used to uppercase an ASCIIZ string. ==Syntax== FSH_UPPERCASE(szPathName, cbPathBuf, pPathBuf) ==Parameters== ;szPathName: is a pointer to the ASCIIZ path..." |
mNo edit summary |
||
| Line 1: | Line 1: | ||
This function is used to uppercase an ASCIIZ string. | This function is used to uppercase an ASCIIZ string. | ||
==Syntax== | ==Syntax== | ||
FSH_UPPERCASE(szPathName, cbPathBuf, pPathBuf) | FSH_UPPERCASE(szPathName, cbPathBuf, pPathBuf) | ||
==Parameters== | ==Parameters== | ||
;szPathName: is a pointer to the ASCIIZ pathname to be uppercased. | ;szPathName: is a pointer to the ASCIIZ pathname to be uppercased. | ||
;cbPathBuf: is the length of the pathname buffer. | |||
;cbPathBuf: is the length of the pathname buffer. | ;pPathBuf: is a pointer to the buffer to copy the uppercased path into | ||
==Returns== | ==Returns== | ||
If no error is detected, a zero error code is returned. If an error is detected, the following error code is returned: | If no error is detected, a zero error code is returned. If an error is detected, the following error code is returned: | ||
*ERROR_BUFFER_OVERFLOW :uppercased pathname is too long to fit into buffer. | |||
==Calling Sequence== | ==Calling Sequence== | ||
<PRE> | <PRE> | ||
int far pascal FSH_UPPERCASE(szPathName, cbPathBuf, pPathBuf) | int far pascal FSH_UPPERCASE(szPathName, cbPathBuf, pPathBuf) | ||
| Line 24: | Line 21: | ||
char far * pPathBuf; | char far * pPathBuf; | ||
</PRE> | </PRE> | ||
==Remarks== | ==Remarks== | ||
This routine processes DBCS characters properly. | This routine processes DBCS characters properly. | ||
The FSD is responsible for verifying the string pointers and checking for segment boundaries. | The FSD is responsible for verifying the string pointers and checking for segment boundaries. | ||
szPathName and pPathBuf may point to the same place in memory. | szPathName and pPathBuf may point to the same place in memory. | ||
FSH_UPPERCASE should be called for names passed into the FSD in raw data packets which are not passed to FSH_CANONICALIZE and should be uppercased, that is, extended attribute names. | FSH_UPPERCASE should be called for names passed into the FSD in raw data packets which are not passed to FSH_CANONICALIZE and should be uppercased, that is, extended attribute names. | ||
;Note: OS/2 does not validate input parameters. Therefore, an FSD should call FSH_PROBEBUF where appropriate. | ;Note: OS/2 does not validate input parameters. Therefore, an FSD should call FSH_PROBEBUF where appropriate. | ||
[[Category:IFS Interfaces]] | [[Category:IFS Interfaces]] | ||
{{DISPLAYTITLE:PCSP_INFO}} | {{DISPLAYTITLE:PCSP_INFO}} | ||
Revision as of 22:00, 12 February 2020
This function is used to uppercase an ASCIIZ string.
Syntax
FSH_UPPERCASE(szPathName, cbPathBuf, pPathBuf)
Parameters
- szPathName
- is a pointer to the ASCIIZ pathname to be uppercased.
- cbPathBuf
- is the length of the pathname buffer.
- pPathBuf
- is a pointer to the buffer to copy the uppercased path into
Returns
If no error is detected, a zero error code is returned. If an error is detected, the following error code is returned:
- ERROR_BUFFER_OVERFLOW :uppercased pathname is too long to fit into buffer.
Calling Sequence
int far pascal FSH_UPPERCASE(szPathName, cbPathBuf, pPathBuf) char far * szPathName; unsigned short cbPathBuf; char far * pPathBuf;
Remarks
This routine processes DBCS characters properly.
The FSD is responsible for verifying the string pointers and checking for segment boundaries.
szPathName and pPathBuf may point to the same place in memory.
FSH_UPPERCASE should be called for names passed into the FSD in raw data packets which are not passed to FSH_CANONICALIZE and should be uppercased, that is, extended attribute names.
- Note
- OS/2 does not validate input parameters. Therefore, an FSD should call FSH_PROBEBUF where appropriate.